Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 1 | |
| 2 | /* Thread and interpreter state structures and their interfaces */ |
| 3 | |
| 4 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 5 | #ifndef Py_PYSTATE_H |
| 6 | #define Py_PYSTATE_H |
| 7 | #ifdef __cplusplus |
| 8 | extern "C" { |
| 9 | #endif |
| 10 | |
Brett Cannon | 5c4de28 | 2016-09-07 11:16:41 -0700 | [diff] [blame] | 11 | /* This limitation is for performance and simplicity. If needed it can be |
| 12 | removed (with effort). */ |
| 13 | #define MAX_CO_EXTRA_USERS 255 |
| 14 | |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 15 | /* State shared between threads */ |
| 16 | |
Guido van Rossum | 29e46a9 | 1997-08-02 02:56:48 +0000 | [diff] [blame] | 17 | struct _ts; /* Forward */ |
| 18 | struct _is; /* Forward */ |
Brett Cannon | 3cebf93 | 2016-09-05 15:33:46 -0700 | [diff] [blame] | 19 | struct _frame; /* Forward declaration for PyFrameObject. */ |
Guido van Rossum | 29e46a9 | 1997-08-02 02:56:48 +0000 | [diff] [blame] | 20 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 21 | #ifdef Py_LIMITED_API |
| 22 | typedef struct _is PyInterpreterState; |
| 23 | #else |
Brett Cannon | 3cebf93 | 2016-09-05 15:33:46 -0700 | [diff] [blame] | 24 | typedef PyObject* (*_PyFrameEvalFunction)(struct _frame *, int); |
| 25 | |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 26 | typedef struct _is { |
| 27 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 28 | struct _is *next; |
| 29 | struct _ts *tstate_head; |
Guido van Rossum | 29e46a9 | 1997-08-02 02:56:48 +0000 | [diff] [blame] | 30 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 31 | PyObject *modules; |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 32 | PyObject *modules_by_index; |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 33 | PyObject *sysdict; |
| 34 | PyObject *builtins; |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 35 | PyObject *importlib; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 36 | |
Gustavo Niemeyer | 5ddd4c3 | 2003-03-19 00:35:36 +0000 | [diff] [blame] | 37 | PyObject *codec_search_path; |
| 38 | PyObject *codec_search_cache; |
| 39 | PyObject *codec_error_registry; |
Christian Heimes | 6a27efa | 2008-10-30 21:48:26 +0000 | [diff] [blame] | 40 | int codecs_initialized; |
Victor Stinner | 793b531 | 2011-04-27 00:24:21 +0200 | [diff] [blame] | 41 | int fscodec_initialized; |
Gustavo Niemeyer | 5ddd4c3 | 2003-03-19 00:35:36 +0000 | [diff] [blame] | 42 | |
Martin v. Löwis | f0473d5 | 2001-07-18 16:17:16 +0000 | [diff] [blame] | 43 | #ifdef HAVE_DLOPEN |
| 44 | int dlopenflags; |
| 45 | #endif |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 46 | |
Serhiy Storchaka | 87a5c51 | 2014-02-10 18:21:34 +0200 | [diff] [blame] | 47 | PyObject *builtins_copy; |
Serhiy Storchaka | 133138a | 2016-08-02 22:51:21 +0300 | [diff] [blame] | 48 | PyObject *import_func; |
Brett Cannon | 3cebf93 | 2016-09-05 15:33:46 -0700 | [diff] [blame] | 49 | /* Initialized to PyEval_EvalFrameDefault(). */ |
| 50 | _PyFrameEvalFunction eval_frame; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 51 | } PyInterpreterState; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 52 | #endif |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 53 | |
| 54 | |
| 55 | /* State unique per thread */ |
| 56 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 57 | #ifndef Py_LIMITED_API |
Fred Drake | 55fb6e0 | 2001-06-27 19:18:03 +0000 | [diff] [blame] | 58 | /* Py_tracefunc return -1 when raising an exception, or 0 for success. */ |
| 59 | typedef int (*Py_tracefunc)(PyObject *, struct _frame *, int, PyObject *); |
| 60 | |
| 61 | /* The following values are used for 'what' for tracefunc functions: */ |
| 62 | #define PyTrace_CALL 0 |
| 63 | #define PyTrace_EXCEPTION 1 |
| 64 | #define PyTrace_LINE 2 |
| 65 | #define PyTrace_RETURN 3 |
Nicholas Bastin | c69ebe8 | 2004-03-24 21:57:10 +0000 | [diff] [blame] | 66 | #define PyTrace_C_CALL 4 |
| 67 | #define PyTrace_C_EXCEPTION 5 |
| 68 | #define PyTrace_C_RETURN 6 |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 69 | #endif |
Fred Drake | 55fb6e0 | 2001-06-27 19:18:03 +0000 | [diff] [blame] | 70 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 71 | #ifdef Py_LIMITED_API |
| 72 | typedef struct _ts PyThreadState; |
| 73 | #else |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 74 | typedef struct _ts { |
Brett Cannon | 55fa66d | 2005-06-25 07:07:35 +0000 | [diff] [blame] | 75 | /* See Python/ceval.c for comments explaining most fields */ |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 76 | |
Charles-Francois Natali | f28dfdd | 2013-05-08 21:09:52 +0200 | [diff] [blame] | 77 | struct _ts *prev; |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 78 | struct _ts *next; |
| 79 | PyInterpreterState *interp; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 80 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 81 | struct _frame *frame; |
| 82 | int recursion_depth; |
Martin v. Löwis | 5b22213 | 2007-06-10 09:51:05 +0000 | [diff] [blame] | 83 | char overflowed; /* The stack has overflowed. Allow 50 more calls |
Victor Stinner | 8e4d407 | 2011-04-26 23:34:58 +0200 | [diff] [blame] | 84 | to handle the runtime error. */ |
| 85 | char recursion_critical; /* The current calls must not cause |
| 86 | a stack overflow. */ |
Brett Cannon | 55fa66d | 2005-06-25 07:07:35 +0000 | [diff] [blame] | 87 | /* 'tracing' keeps track of the execution depth when tracing/profiling. |
| 88 | This is to prevent the actual trace/profile code from being recorded in |
| 89 | the trace/profile. */ |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 90 | int tracing; |
Fred Drake | 9e3ad78 | 2001-07-03 23:39:52 +0000 | [diff] [blame] | 91 | int use_tracing; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 92 | |
Fred Drake | 55fb6e0 | 2001-06-27 19:18:03 +0000 | [diff] [blame] | 93 | Py_tracefunc c_profilefunc; |
| 94 | Py_tracefunc c_tracefunc; |
| 95 | PyObject *c_profileobj; |
| 96 | PyObject *c_traceobj; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 97 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 98 | PyObject *curexc_type; |
| 99 | PyObject *curexc_value; |
| 100 | PyObject *curexc_traceback; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 101 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 102 | PyObject *exc_type; |
| 103 | PyObject *exc_value; |
| 104 | PyObject *exc_traceback; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 105 | |
Brett Cannon | 55fa66d | 2005-06-25 07:07:35 +0000 | [diff] [blame] | 106 | PyObject *dict; /* Stores per-thread state */ |
Guido van Rossum | ee0a63b | 1998-04-13 20:24:05 +0000 | [diff] [blame] | 107 | |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 108 | int gilstate_counter; |
Michael W. Hudson | 019a78e | 2002-11-08 12:53:11 +0000 | [diff] [blame] | 109 | |
Guido van Rossum | b8b6d0c | 2003-06-28 21:53:52 +0000 | [diff] [blame] | 110 | PyObject *async_exc; /* Asynchronous exception to raise */ |
| 111 | long thread_id; /* Thread id where this tstate was created */ |
| 112 | |
Antoine Pitrou | 2b0218a | 2012-09-06 00:59:49 +0200 | [diff] [blame] | 113 | int trash_delete_nesting; |
| 114 | PyObject *trash_delete_later; |
| 115 | |
Antoine Pitrou | 7b47699 | 2013-09-07 23:38:37 +0200 | [diff] [blame] | 116 | /* Called when a thread state is deleted normally, but not when it |
| 117 | * is destroyed after fork(). |
| 118 | * Pain: to prevent rare but fatal shutdown errors (issue 18808), |
| 119 | * Thread.join() must wait for the join'ed thread's tstate to be unlinked |
| 120 | * from the tstate chain. That happens at the end of a thread's life, |
| 121 | * in pystate.c. |
| 122 | * The obvious way doesn't quite work: create a lock which the tstate |
| 123 | * unlinking code releases, and have Thread.join() wait to acquire that |
| 124 | * lock. The problem is that we _are_ at the end of the thread's life: |
| 125 | * if the thread holds the last reference to the lock, decref'ing the |
| 126 | * lock will delete the lock, and that may trigger arbitrary Python code |
| 127 | * if there's a weakref, with a callback, to the lock. But by this time |
| 128 | * _PyThreadState_Current is already NULL, so only the simplest of C code |
| 129 | * can be allowed to run (in particular it must not be possible to |
| 130 | * release the GIL). |
| 131 | * So instead of holding the lock directly, the tstate holds a weakref to |
| 132 | * the lock: that's the value of on_delete_data below. Decref'ing a |
| 133 | * weakref is harmless. |
| 134 | * on_delete points to _threadmodule.c's static release_sentinel() function. |
| 135 | * After the tstate is unlinked, release_sentinel is called with the |
| 136 | * weakref-to-lock (on_delete_data) argument, and release_sentinel releases |
| 137 | * the indirectly held lock. |
| 138 | */ |
| 139 | void (*on_delete)(void *); |
| 140 | void *on_delete_data; |
| 141 | |
Yury Selivanov | 7544508 | 2015-05-11 22:57:16 -0400 | [diff] [blame] | 142 | PyObject *coroutine_wrapper; |
Yury Selivanov | aab3c4a | 2015-06-02 18:43:51 -0400 | [diff] [blame] | 143 | int in_coroutine_wrapper; |
Yury Selivanov | 7544508 | 2015-05-11 22:57:16 -0400 | [diff] [blame] | 144 | |
Brett Cannon | 5c4de28 | 2016-09-07 11:16:41 -0700 | [diff] [blame] | 145 | Py_ssize_t co_extra_user_count; |
| 146 | freefunc co_extra_freefuncs[MAX_CO_EXTRA_USERS]; |
| 147 | |
Yury Selivanov | eb63645 | 2016-09-08 22:01:51 -0700 | [diff] [blame] | 148 | PyObject *async_gen_firstiter; |
| 149 | PyObject *async_gen_finalizer; |
| 150 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 151 | /* XXX signal handlers should also be here */ |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 152 | |
| 153 | } PyThreadState; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 154 | #endif |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 155 | |
| 156 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 157 | PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_New(void); |
| 158 | PyAPI_FUNC(void) PyInterpreterState_Clear(PyInterpreterState *); |
| 159 | PyAPI_FUNC(void) PyInterpreterState_Delete(PyInterpreterState *); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 160 | #ifndef Py_LIMITED_API |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 161 | PyAPI_FUNC(int) _PyState_AddModule(PyObject*, struct PyModuleDef*); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 162 | #endif /* !Py_LIMITED_API */ |
Martin v. Löwis | 7800f75 | 2012-06-22 12:20:55 +0200 | [diff] [blame] | 163 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000 |
| 164 | /* New in 3.3 */ |
| 165 | PyAPI_FUNC(int) PyState_AddModule(PyObject*, struct PyModuleDef*); |
| 166 | PyAPI_FUNC(int) PyState_RemoveModule(struct PyModuleDef*); |
| 167 | #endif |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 168 | PyAPI_FUNC(PyObject*) PyState_FindModule(struct PyModuleDef*); |
Antoine Pitrou | 40322e6 | 2013-08-11 00:30:09 +0200 | [diff] [blame] | 169 | #ifndef Py_LIMITED_API |
| 170 | PyAPI_FUNC(void) _PyState_ClearModules(void); |
| 171 | #endif |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 172 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 173 | PyAPI_FUNC(PyThreadState *) PyThreadState_New(PyInterpreterState *); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 174 | #ifndef Py_LIMITED_API |
Victor Stinner | 45b9be5 | 2010-03-03 23:28:07 +0000 | [diff] [blame] | 175 | PyAPI_FUNC(PyThreadState *) _PyThreadState_Prealloc(PyInterpreterState *); |
| 176 | PyAPI_FUNC(void) _PyThreadState_Init(PyThreadState *); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 177 | #endif /* !Py_LIMITED_API */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 178 | PyAPI_FUNC(void) PyThreadState_Clear(PyThreadState *); |
| 179 | PyAPI_FUNC(void) PyThreadState_Delete(PyThreadState *); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 180 | #ifndef Py_LIMITED_API |
Antoine Pitrou | 8408cea | 2013-05-05 23:47:09 +0200 | [diff] [blame] | 181 | PyAPI_FUNC(void) _PyThreadState_DeleteExcept(PyThreadState *tstate); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 182 | #endif /* !Py_LIMITED_API */ |
Guido van Rossum | 2975786 | 2001-01-23 01:46:06 +0000 | [diff] [blame] | 183 | #ifdef WITH_THREAD |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 184 | PyAPI_FUNC(void) PyThreadState_DeleteCurrent(void); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 185 | #ifndef Py_LIMITED_API |
Antoine Pitrou | 0c759fe | 2011-04-27 19:28:05 +0200 | [diff] [blame] | 186 | PyAPI_FUNC(void) _PyGILState_Reinit(void); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 187 | #endif /* !Py_LIMITED_API */ |
Guido van Rossum | 2975786 | 2001-01-23 01:46:06 +0000 | [diff] [blame] | 188 | #endif |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 189 | |
Victor Stinner | bfd316e | 2016-01-20 11:12:38 +0100 | [diff] [blame] | 190 | /* Return the current thread state. The global interpreter lock must be held. |
| 191 | * When the current thread state is NULL, this issues a fatal error (so that |
| 192 | * the caller needn't check for NULL). */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 193 | PyAPI_FUNC(PyThreadState *) PyThreadState_Get(void); |
Victor Stinner | bfd316e | 2016-01-20 11:12:38 +0100 | [diff] [blame] | 194 | |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 195 | #ifndef Py_LIMITED_API |
Victor Stinner | bfd316e | 2016-01-20 11:12:38 +0100 | [diff] [blame] | 196 | /* Similar to PyThreadState_Get(), but don't issue a fatal error |
| 197 | * if it is NULL. */ |
| 198 | PyAPI_FUNC(PyThreadState *) _PyThreadState_UncheckedGet(void); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 199 | #endif /* !Py_LIMITED_API */ |
Victor Stinner | bfd316e | 2016-01-20 11:12:38 +0100 | [diff] [blame] | 200 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 201 | PyAPI_FUNC(PyThreadState *) PyThreadState_Swap(PyThreadState *); |
| 202 | PyAPI_FUNC(PyObject *) PyThreadState_GetDict(void); |
Guido van Rossum | b8b6d0c | 2003-06-28 21:53:52 +0000 | [diff] [blame] | 203 | PyAPI_FUNC(int) PyThreadState_SetAsyncExc(long, PyObject *); |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 204 | |
Guido van Rossum | 275ea67 | 1998-12-21 18:28:10 +0000 | [diff] [blame] | 205 | |
| 206 | /* Variable and macro for in-line access to current thread state */ |
| 207 | |
Jeffrey Yasskin | 3937083 | 2010-05-03 19:29:34 +0000 | [diff] [blame] | 208 | /* Assuming the current thread holds the GIL, this is the |
Victor Stinner | 6df29ad | 2015-09-18 15:06:34 +0200 | [diff] [blame] | 209 | PyThreadState for the current thread. */ |
| 210 | #ifdef Py_BUILD_CORE |
Jeffrey Yasskin | 3937083 | 2010-05-03 19:29:34 +0000 | [diff] [blame] | 211 | PyAPI_DATA(_Py_atomic_address) _PyThreadState_Current; |
Victor Stinner | 6df29ad | 2015-09-18 15:06:34 +0200 | [diff] [blame] | 212 | # define PyThreadState_GET() \ |
| 213 | ((PyThreadState*)_Py_atomic_load_relaxed(&_PyThreadState_Current)) |
Guido van Rossum | 275ea67 | 1998-12-21 18:28:10 +0000 | [diff] [blame] | 214 | #else |
Victor Stinner | 6df29ad | 2015-09-18 15:06:34 +0200 | [diff] [blame] | 215 | # define PyThreadState_GET() PyThreadState_Get() |
Guido van Rossum | 275ea67 | 1998-12-21 18:28:10 +0000 | [diff] [blame] | 216 | #endif |
| 217 | |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 218 | typedef |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 219 | enum {PyGILState_LOCKED, PyGILState_UNLOCKED} |
| 220 | PyGILState_STATE; |
| 221 | |
Victor Stinner | 8e4d407 | 2011-04-26 23:34:58 +0200 | [diff] [blame] | 222 | #ifdef WITH_THREAD |
| 223 | |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 224 | /* Ensure that the current thread is ready to call the Python |
| 225 | C API, regardless of the current state of Python, or of its |
| 226 | thread lock. This may be called as many times as desired |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 227 | by a thread so long as each call is matched with a call to |
| 228 | PyGILState_Release(). In general, other thread-state APIs may |
| 229 | be used between _Ensure() and _Release() calls, so long as the |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 230 | thread-state is restored to its previous state before the Release(). |
| 231 | For example, normal use of the Py_BEGIN_ALLOW_THREADS/ |
| 232 | Py_END_ALLOW_THREADS macros are acceptable. |
| 233 | |
| 234 | The return value is an opaque "handle" to the thread state when |
Raymond Hettinger | 4eec95a | 2004-03-13 20:45:47 +0000 | [diff] [blame] | 235 | PyGILState_Ensure() was called, and must be passed to |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 236 | PyGILState_Release() to ensure Python is left in the same state. Even |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 237 | though recursive calls are allowed, these handles can *not* be shared - |
| 238 | each unique call to PyGILState_Ensure must save the handle for its |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 239 | call to PyGILState_Release. |
| 240 | |
| 241 | When the function returns, the current thread will hold the GIL. |
| 242 | |
| 243 | Failure is a fatal error. |
| 244 | */ |
| 245 | PyAPI_FUNC(PyGILState_STATE) PyGILState_Ensure(void); |
| 246 | |
| 247 | /* Release any resources previously acquired. After this call, Python's |
| 248 | state will be the same as it was prior to the corresponding |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 249 | PyGILState_Ensure() call (but generally this state will be unknown to |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 250 | the caller, hence the use of the GILState API.) |
| 251 | |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 252 | Every call to PyGILState_Ensure must be matched by a call to |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 253 | PyGILState_Release on the same thread. |
| 254 | */ |
| 255 | PyAPI_FUNC(void) PyGILState_Release(PyGILState_STATE); |
| 256 | |
| 257 | /* Helper/diagnostic function - get the current thread state for |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 258 | this thread. May return NULL if no GILState API has been used |
Sandro Tosi | 61baee0 | 2011-08-08 00:16:54 +0200 | [diff] [blame] | 259 | on the current thread. Note that the main thread always has such a |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 260 | thread-state, even if no auto-thread-state call has been made |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 261 | on the main thread. |
| 262 | */ |
| 263 | PyAPI_FUNC(PyThreadState *) PyGILState_GetThisThreadState(void); |
| 264 | |
Martin v. Löwis | 1c0689c | 2014-01-03 21:36:49 +0100 | [diff] [blame] | 265 | #ifndef Py_LIMITED_API |
Victor Stinner | 8a1be61 | 2016-03-14 22:07:55 +0100 | [diff] [blame] | 266 | /* Issue #26558: Flag to disable PyGILState_Check(). |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 267 | If set to non-zero, PyGILState_Check() always return 1. */ |
Victor Stinner | 8a1be61 | 2016-03-14 22:07:55 +0100 | [diff] [blame] | 268 | PyAPI_DATA(int) _PyGILState_check_enabled; |
| 269 | |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 270 | /* Helper/diagnostic function - return 1 if the current thread |
| 271 | currently holds the GIL, 0 otherwise. |
| 272 | |
| 273 | The function returns 1 if _PyGILState_check_enabled is non-zero. */ |
Kristján Valur Jónsson | 684cd0e | 2013-03-23 03:36:16 -0700 | [diff] [blame] | 274 | PyAPI_FUNC(int) PyGILState_Check(void); |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 275 | |
| 276 | /* Unsafe function to get the single PyInterpreterState used by this process' |
| 277 | GILState implementation. |
| 278 | |
| 279 | Return NULL before _PyGILState_Init() is called and after _PyGILState_Fini() |
| 280 | is called. */ |
| 281 | PyAPI_FUNC(PyInterpreterState *) _PyGILState_GetInterpreterStateUnsafe(void); |
Martin v. Löwis | 1c0689c | 2014-01-03 21:36:49 +0100 | [diff] [blame] | 282 | #endif |
Kristján Valur Jónsson | 684cd0e | 2013-03-23 03:36:16 -0700 | [diff] [blame] | 283 | |
Victor Stinner | 8e4d407 | 2011-04-26 23:34:58 +0200 | [diff] [blame] | 284 | #endif /* #ifdef WITH_THREAD */ |
| 285 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 286 | /* The implementation of sys._current_frames() Returns a dict mapping |
| 287 | thread id to that thread's current frame. |
| 288 | */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 289 | #ifndef Py_LIMITED_API |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 290 | PyAPI_FUNC(PyObject *) _PyThread_CurrentFrames(void); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 291 | #endif |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 292 | |
Guido van Rossum | f5df46d | 2001-07-19 12:19:27 +0000 | [diff] [blame] | 293 | /* Routines for advanced debuggers, requested by David Beazley. |
| 294 | Don't use unless you know what you are doing! */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 295 | #ifndef Py_LIMITED_API |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 296 | PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_Head(void); |
| 297 | PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_Next(PyInterpreterState *); |
| 298 | PyAPI_FUNC(PyThreadState *) PyInterpreterState_ThreadHead(PyInterpreterState *); |
| 299 | PyAPI_FUNC(PyThreadState *) PyThreadState_Next(PyThreadState *); |
Guido van Rossum | f5df46d | 2001-07-19 12:19:27 +0000 | [diff] [blame] | 300 | |
Guido van Rossum | 6297a7a | 2003-02-19 15:53:17 +0000 | [diff] [blame] | 301 | typedef struct _frame *(*PyThreadFrameGetter)(PyThreadState *self_); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 302 | #endif |
Guido van Rossum | 6297a7a | 2003-02-19 15:53:17 +0000 | [diff] [blame] | 303 | |
Michael W. Hudson | 019a78e | 2002-11-08 12:53:11 +0000 | [diff] [blame] | 304 | /* hook for PyEval_GetFrame(), requested for Psyco */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 305 | #ifndef Py_LIMITED_API |
Guido van Rossum | 6297a7a | 2003-02-19 15:53:17 +0000 | [diff] [blame] | 306 | PyAPI_DATA(PyThreadFrameGetter) _PyThreadState_GetFrame; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 307 | #endif |
Michael W. Hudson | 019a78e | 2002-11-08 12:53:11 +0000 | [diff] [blame] | 308 | |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 309 | #ifdef __cplusplus |
| 310 | } |
| 311 | #endif |
| 312 | #endif /* !Py_PYSTATE_H */ |