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 | |
Eric Snow | 1abcf67 | 2017-05-23 21:46:51 -0700 | [diff] [blame] | 26 | |
| 27 | typedef struct { |
Victor Stinner | 25420fe | 2017-11-20 18:12:22 -0800 | [diff] [blame] | 28 | int ignore_environment; /* -E */ |
| 29 | int use_hash_seed; /* PYTHONHASHSEED=x */ |
Eric Snow | 1abcf67 | 2017-05-23 21:46:51 -0700 | [diff] [blame] | 30 | unsigned long hash_seed; |
| 31 | int _disable_importlib; /* Needed by freeze_importlib */ |
Victor Stinner | 25420fe | 2017-11-20 18:12:22 -0800 | [diff] [blame] | 32 | const char *allocator; /* Memory allocator: _PyMem_SetupAllocators() */ |
Victor Stinner | 09f3a8a | 2017-11-20 17:32:40 -0800 | [diff] [blame] | 33 | int dev_mode; /* -X dev */ |
Victor Stinner | 25420fe | 2017-11-20 18:12:22 -0800 | [diff] [blame] | 34 | int faulthandler; /* -X faulthandler */ |
| 35 | int tracemalloc; /* -X tracemalloc=N */ |
| 36 | int import_time; /* -X importtime */ |
| 37 | int show_ref_count; /* -X showrefcount */ |
| 38 | int show_alloc_count; /* -X showalloccount */ |
Victor Stinner | 6bf992a | 2017-12-06 17:26:10 +0100 | [diff] [blame] | 39 | int dump_refs; /* PYTHONDUMPREFS */ |
| 40 | int malloc_stats; /* PYTHONMALLOCSTATS */ |
Victor Stinner | 91106cd | 2017-12-13 12:29:09 +0100 | [diff] [blame] | 41 | int utf8_mode; /* -X utf8 or PYTHONUTF8 environment variable */ |
Victor Stinner | b5fd9ad | 2017-12-14 02:20:52 +0100 | [diff] [blame] | 42 | |
| 43 | wchar_t *module_search_path_env; /* PYTHONPATH environment variable */ |
| 44 | wchar_t *home; /* PYTHONHOME environment variable, |
| 45 | see also Py_SetPythonHome(). */ |
| 46 | wchar_t *program_name; /* Program name, see also Py_GetProgramName() */ |
Eric Snow | 1abcf67 | 2017-05-23 21:46:51 -0700 | [diff] [blame] | 47 | } _PyCoreConfig; |
| 48 | |
Victor Stinner | 33c377e | 2017-12-05 15:12:41 +0100 | [diff] [blame] | 49 | #define _PyCoreConfig_INIT (_PyCoreConfig){.use_hash_seed = -1} |
| 50 | /* Note: _PyCoreConfig_INIT sets other fields to 0/NULL */ |
Eric Snow | 1abcf67 | 2017-05-23 21:46:51 -0700 | [diff] [blame] | 51 | |
Eric Snow | c7ec998 | 2017-05-23 23:00:52 -0700 | [diff] [blame] | 52 | /* Placeholders while working on the new configuration API |
| 53 | * |
| 54 | * See PEP 432 for final anticipated contents |
| 55 | * |
| 56 | * For the moment, just handle the args to _Py_InitializeEx |
| 57 | */ |
| 58 | typedef struct { |
| 59 | int install_signal_handlers; |
Victor Stinner | b5fd9ad | 2017-12-14 02:20:52 +0100 | [diff] [blame] | 60 | PyObject *argv; /* sys.argv list, can be NULL */ |
| 61 | PyObject *module_search_path; /* sys.path list */ |
Victor Stinner | 374c6e1 | 2017-12-14 12:05:26 +0100 | [diff] [blame^] | 62 | PyObject *warnoptions; /* sys.warnoptions list, can be NULL */ |
| 63 | PyObject *xoptions; /* sys._xoptions dict, can be NULL */ |
Eric Snow | c7ec998 | 2017-05-23 23:00:52 -0700 | [diff] [blame] | 64 | } _PyMainInterpreterConfig; |
| 65 | |
Victor Stinner | d434110 | 2017-11-23 00:12:09 +0100 | [diff] [blame] | 66 | #define _PyMainInterpreterConfig_INIT \ |
Victor Stinner | 33c377e | 2017-12-05 15:12:41 +0100 | [diff] [blame] | 67 | (_PyMainInterpreterConfig){.install_signal_handlers = -1} |
| 68 | /* Note: _PyMainInterpreterConfig_INIT sets other fields to 0/NULL */ |
Eric Snow | c7ec998 | 2017-05-23 23:00:52 -0700 | [diff] [blame] | 69 | |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 70 | typedef struct _is { |
| 71 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 72 | struct _is *next; |
| 73 | struct _ts *tstate_head; |
Guido van Rossum | 29e46a9 | 1997-08-02 02:56:48 +0000 | [diff] [blame] | 74 | |
Eric Snow | e377416 | 2017-05-22 19:46:40 -0700 | [diff] [blame] | 75 | int64_t id; |
| 76 | |
Eric Snow | 93c92f7 | 2017-09-13 23:46:04 -0700 | [diff] [blame] | 77 | PyObject *modules; |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 78 | PyObject *modules_by_index; |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 79 | PyObject *sysdict; |
| 80 | PyObject *builtins; |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 81 | PyObject *importlib; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 82 | |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 83 | /* Used in Python/sysmodule.c. */ |
| 84 | int check_interval; |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 85 | |
| 86 | /* Used in Modules/_threadmodule.c. */ |
| 87 | long num_threads; |
| 88 | /* Support for runtime thread stack size tuning. |
| 89 | A value of 0 means using the platform's default stack size |
| 90 | or the size specified by the THREAD_STACK_SIZE macro. */ |
| 91 | /* Used in Python/thread.c. */ |
| 92 | size_t pythread_stacksize; |
| 93 | |
Gustavo Niemeyer | 5ddd4c3 | 2003-03-19 00:35:36 +0000 | [diff] [blame] | 94 | PyObject *codec_search_path; |
| 95 | PyObject *codec_search_cache; |
| 96 | PyObject *codec_error_registry; |
Christian Heimes | 6a27efa | 2008-10-30 21:48:26 +0000 | [diff] [blame] | 97 | int codecs_initialized; |
Victor Stinner | 793b531 | 2011-04-27 00:24:21 +0200 | [diff] [blame] | 98 | int fscodec_initialized; |
Gustavo Niemeyer | 5ddd4c3 | 2003-03-19 00:35:36 +0000 | [diff] [blame] | 99 | |
Eric Snow | 1abcf67 | 2017-05-23 21:46:51 -0700 | [diff] [blame] | 100 | _PyCoreConfig core_config; |
Eric Snow | c7ec998 | 2017-05-23 23:00:52 -0700 | [diff] [blame] | 101 | _PyMainInterpreterConfig config; |
Martin v. Löwis | f0473d5 | 2001-07-18 16:17:16 +0000 | [diff] [blame] | 102 | #ifdef HAVE_DLOPEN |
| 103 | int dlopenflags; |
| 104 | #endif |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 105 | |
Serhiy Storchaka | 87a5c51 | 2014-02-10 18:21:34 +0200 | [diff] [blame] | 106 | PyObject *builtins_copy; |
Serhiy Storchaka | 133138a | 2016-08-02 22:51:21 +0300 | [diff] [blame] | 107 | PyObject *import_func; |
Brett Cannon | 3cebf93 | 2016-09-05 15:33:46 -0700 | [diff] [blame] | 108 | /* Initialized to PyEval_EvalFrameDefault(). */ |
| 109 | _PyFrameEvalFunction eval_frame; |
Dino Viehland | f3cffd2 | 2017-06-21 14:44:36 -0700 | [diff] [blame] | 110 | |
| 111 | Py_ssize_t co_extra_user_count; |
| 112 | freefunc co_extra_freefuncs[MAX_CO_EXTRA_USERS]; |
| 113 | |
Antoine Pitrou | 346cbd3 | 2017-05-27 17:50:54 +0200 | [diff] [blame] | 114 | #ifdef HAVE_FORK |
| 115 | PyObject *before_forkers; |
| 116 | PyObject *after_forkers_parent; |
| 117 | PyObject *after_forkers_child; |
| 118 | #endif |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 119 | } PyInterpreterState; |
Victor Stinner | 6bf992a | 2017-12-06 17:26:10 +0100 | [diff] [blame] | 120 | #endif /* !Py_LIMITED_API */ |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 121 | |
| 122 | |
| 123 | /* State unique per thread */ |
| 124 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 125 | #ifndef Py_LIMITED_API |
Fred Drake | 55fb6e0 | 2001-06-27 19:18:03 +0000 | [diff] [blame] | 126 | /* Py_tracefunc return -1 when raising an exception, or 0 for success. */ |
| 127 | typedef int (*Py_tracefunc)(PyObject *, struct _frame *, int, PyObject *); |
| 128 | |
Nick Coghlan | 5a85167 | 2017-09-08 10:14:16 +1000 | [diff] [blame] | 129 | /* The following values are used for 'what' for tracefunc functions |
| 130 | * |
| 131 | * To add a new kind of trace event, also update "trace_init" in |
| 132 | * Python/sysmodule.c to define the Python level event name |
| 133 | */ |
Fred Drake | 55fb6e0 | 2001-06-27 19:18:03 +0000 | [diff] [blame] | 134 | #define PyTrace_CALL 0 |
| 135 | #define PyTrace_EXCEPTION 1 |
| 136 | #define PyTrace_LINE 2 |
| 137 | #define PyTrace_RETURN 3 |
Nicholas Bastin | c69ebe8 | 2004-03-24 21:57:10 +0000 | [diff] [blame] | 138 | #define PyTrace_C_CALL 4 |
| 139 | #define PyTrace_C_EXCEPTION 5 |
| 140 | #define PyTrace_C_RETURN 6 |
Nick Coghlan | 5a85167 | 2017-09-08 10:14:16 +1000 | [diff] [blame] | 141 | #define PyTrace_OPCODE 7 |
Victor Stinner | 6bf992a | 2017-12-06 17:26:10 +0100 | [diff] [blame] | 142 | #endif /* Py_LIMITED_API */ |
Fred Drake | 55fb6e0 | 2001-06-27 19:18:03 +0000 | [diff] [blame] | 143 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 144 | #ifdef Py_LIMITED_API |
| 145 | typedef struct _ts PyThreadState; |
| 146 | #else |
Mark Shannon | ae3087c | 2017-10-22 22:41:51 +0100 | [diff] [blame] | 147 | |
| 148 | typedef struct _err_stackitem { |
Serhiy Storchaka | bdf4298 | 2017-10-26 16:59:40 +0300 | [diff] [blame] | 149 | /* This struct represents an entry on the exception stack, which is a |
| 150 | * per-coroutine state. (Coroutine in the computer science sense, |
Mark Shannon | ae3087c | 2017-10-22 22:41:51 +0100 | [diff] [blame] | 151 | * including the thread and generators). |
| 152 | * This ensures that the exception state is not impacted by "yields" |
| 153 | * from an except handler. |
| 154 | */ |
| 155 | PyObject *exc_type, *exc_value, *exc_traceback; |
| 156 | |
| 157 | struct _err_stackitem *previous_item; |
| 158 | |
| 159 | } _PyErr_StackItem; |
| 160 | |
| 161 | |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 162 | typedef struct _ts { |
Brett Cannon | 55fa66d | 2005-06-25 07:07:35 +0000 | [diff] [blame] | 163 | /* See Python/ceval.c for comments explaining most fields */ |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 164 | |
Charles-Francois Natali | f28dfdd | 2013-05-08 21:09:52 +0200 | [diff] [blame] | 165 | struct _ts *prev; |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 166 | struct _ts *next; |
| 167 | PyInterpreterState *interp; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 168 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 169 | struct _frame *frame; |
| 170 | int recursion_depth; |
Martin v. Löwis | 5b22213 | 2007-06-10 09:51:05 +0000 | [diff] [blame] | 171 | char overflowed; /* The stack has overflowed. Allow 50 more calls |
Victor Stinner | 8e4d407 | 2011-04-26 23:34:58 +0200 | [diff] [blame] | 172 | to handle the runtime error. */ |
| 173 | char recursion_critical; /* The current calls must not cause |
| 174 | a stack overflow. */ |
pdox | 1896793 | 2017-10-25 23:03:01 -0700 | [diff] [blame] | 175 | int stackcheck_counter; |
| 176 | |
Brett Cannon | 55fa66d | 2005-06-25 07:07:35 +0000 | [diff] [blame] | 177 | /* 'tracing' keeps track of the execution depth when tracing/profiling. |
| 178 | This is to prevent the actual trace/profile code from being recorded in |
| 179 | the trace/profile. */ |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 180 | int tracing; |
Fred Drake | 9e3ad78 | 2001-07-03 23:39:52 +0000 | [diff] [blame] | 181 | int use_tracing; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 182 | |
Fred Drake | 55fb6e0 | 2001-06-27 19:18:03 +0000 | [diff] [blame] | 183 | Py_tracefunc c_profilefunc; |
| 184 | Py_tracefunc c_tracefunc; |
| 185 | PyObject *c_profileobj; |
| 186 | PyObject *c_traceobj; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 187 | |
Mark Shannon | ae3087c | 2017-10-22 22:41:51 +0100 | [diff] [blame] | 188 | /* The exception currently being raised */ |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 189 | PyObject *curexc_type; |
| 190 | PyObject *curexc_value; |
| 191 | PyObject *curexc_traceback; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 192 | |
Mark Shannon | ae3087c | 2017-10-22 22:41:51 +0100 | [diff] [blame] | 193 | /* The exception currently being handled, if no coroutines/generators |
| 194 | * are present. Always last element on the stack referred to be exc_info. |
| 195 | */ |
| 196 | _PyErr_StackItem exc_state; |
| 197 | |
| 198 | /* Pointer to the top of the stack of the exceptions currently |
| 199 | * being handled */ |
| 200 | _PyErr_StackItem *exc_info; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 201 | |
Brett Cannon | 55fa66d | 2005-06-25 07:07:35 +0000 | [diff] [blame] | 202 | PyObject *dict; /* Stores per-thread state */ |
Guido van Rossum | ee0a63b | 1998-04-13 20:24:05 +0000 | [diff] [blame] | 203 | |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 204 | int gilstate_counter; |
Michael W. Hudson | 019a78e | 2002-11-08 12:53:11 +0000 | [diff] [blame] | 205 | |
Guido van Rossum | b8b6d0c | 2003-06-28 21:53:52 +0000 | [diff] [blame] | 206 | PyObject *async_exc; /* Asynchronous exception to raise */ |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 207 | unsigned long thread_id; /* Thread id where this tstate was created */ |
Guido van Rossum | b8b6d0c | 2003-06-28 21:53:52 +0000 | [diff] [blame] | 208 | |
Antoine Pitrou | 2b0218a | 2012-09-06 00:59:49 +0200 | [diff] [blame] | 209 | int trash_delete_nesting; |
| 210 | PyObject *trash_delete_later; |
| 211 | |
Antoine Pitrou | 7b47699 | 2013-09-07 23:38:37 +0200 | [diff] [blame] | 212 | /* Called when a thread state is deleted normally, but not when it |
| 213 | * is destroyed after fork(). |
| 214 | * Pain: to prevent rare but fatal shutdown errors (issue 18808), |
| 215 | * Thread.join() must wait for the join'ed thread's tstate to be unlinked |
| 216 | * from the tstate chain. That happens at the end of a thread's life, |
| 217 | * in pystate.c. |
| 218 | * The obvious way doesn't quite work: create a lock which the tstate |
| 219 | * unlinking code releases, and have Thread.join() wait to acquire that |
| 220 | * lock. The problem is that we _are_ at the end of the thread's life: |
| 221 | * if the thread holds the last reference to the lock, decref'ing the |
| 222 | * lock will delete the lock, and that may trigger arbitrary Python code |
| 223 | * if there's a weakref, with a callback, to the lock. But by this time |
| 224 | * _PyThreadState_Current is already NULL, so only the simplest of C code |
| 225 | * can be allowed to run (in particular it must not be possible to |
| 226 | * release the GIL). |
| 227 | * So instead of holding the lock directly, the tstate holds a weakref to |
| 228 | * the lock: that's the value of on_delete_data below. Decref'ing a |
| 229 | * weakref is harmless. |
| 230 | * on_delete points to _threadmodule.c's static release_sentinel() function. |
| 231 | * After the tstate is unlinked, release_sentinel is called with the |
| 232 | * weakref-to-lock (on_delete_data) argument, and release_sentinel releases |
| 233 | * the indirectly held lock. |
| 234 | */ |
| 235 | void (*on_delete)(void *); |
| 236 | void *on_delete_data; |
| 237 | |
Yury Selivanov | 7544508 | 2015-05-11 22:57:16 -0400 | [diff] [blame] | 238 | PyObject *coroutine_wrapper; |
Yury Selivanov | aab3c4a | 2015-06-02 18:43:51 -0400 | [diff] [blame] | 239 | int in_coroutine_wrapper; |
Yury Selivanov | 7544508 | 2015-05-11 22:57:16 -0400 | [diff] [blame] | 240 | |
Yury Selivanov | eb63645 | 2016-09-08 22:01:51 -0700 | [diff] [blame] | 241 | PyObject *async_gen_firstiter; |
| 242 | PyObject *async_gen_finalizer; |
| 243 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 244 | /* XXX signal handlers should also be here */ |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 245 | |
| 246 | } PyThreadState; |
Victor Stinner | 6bf992a | 2017-12-06 17:26:10 +0100 | [diff] [blame] | 247 | #endif /* !Py_LIMITED_API */ |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 248 | |
| 249 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 250 | PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_New(void); |
| 251 | PyAPI_FUNC(void) PyInterpreterState_Clear(PyInterpreterState *); |
| 252 | PyAPI_FUNC(void) PyInterpreterState_Delete(PyInterpreterState *); |
Eric Snow | e377416 | 2017-05-22 19:46:40 -0700 | [diff] [blame] | 253 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03070000 |
| 254 | /* New in 3.7 */ |
| 255 | PyAPI_FUNC(int64_t) PyInterpreterState_GetID(PyInterpreterState *); |
| 256 | #endif |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 257 | #ifndef Py_LIMITED_API |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 258 | PyAPI_FUNC(int) _PyState_AddModule(PyObject*, struct PyModuleDef*); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 259 | #endif /* !Py_LIMITED_API */ |
Martin v. Löwis | 7800f75 | 2012-06-22 12:20:55 +0200 | [diff] [blame] | 260 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000 |
| 261 | /* New in 3.3 */ |
| 262 | PyAPI_FUNC(int) PyState_AddModule(PyObject*, struct PyModuleDef*); |
| 263 | PyAPI_FUNC(int) PyState_RemoveModule(struct PyModuleDef*); |
| 264 | #endif |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 265 | PyAPI_FUNC(PyObject*) PyState_FindModule(struct PyModuleDef*); |
Antoine Pitrou | 40322e6 | 2013-08-11 00:30:09 +0200 | [diff] [blame] | 266 | #ifndef Py_LIMITED_API |
| 267 | PyAPI_FUNC(void) _PyState_ClearModules(void); |
| 268 | #endif |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 269 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 270 | PyAPI_FUNC(PyThreadState *) PyThreadState_New(PyInterpreterState *); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 271 | #ifndef Py_LIMITED_API |
Victor Stinner | 45b9be5 | 2010-03-03 23:28:07 +0000 | [diff] [blame] | 272 | PyAPI_FUNC(PyThreadState *) _PyThreadState_Prealloc(PyInterpreterState *); |
| 273 | PyAPI_FUNC(void) _PyThreadState_Init(PyThreadState *); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 274 | #endif /* !Py_LIMITED_API */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 275 | PyAPI_FUNC(void) PyThreadState_Clear(PyThreadState *); |
| 276 | PyAPI_FUNC(void) PyThreadState_Delete(PyThreadState *); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 277 | #ifndef Py_LIMITED_API |
Antoine Pitrou | 8408cea | 2013-05-05 23:47:09 +0200 | [diff] [blame] | 278 | PyAPI_FUNC(void) _PyThreadState_DeleteExcept(PyThreadState *tstate); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 279 | #endif /* !Py_LIMITED_API */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 280 | PyAPI_FUNC(void) PyThreadState_DeleteCurrent(void); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 281 | #ifndef Py_LIMITED_API |
Antoine Pitrou | 0c759fe | 2011-04-27 19:28:05 +0200 | [diff] [blame] | 282 | PyAPI_FUNC(void) _PyGILState_Reinit(void); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 283 | #endif /* !Py_LIMITED_API */ |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 284 | |
Victor Stinner | bfd316e | 2016-01-20 11:12:38 +0100 | [diff] [blame] | 285 | /* Return the current thread state. The global interpreter lock must be held. |
| 286 | * When the current thread state is NULL, this issues a fatal error (so that |
| 287 | * the caller needn't check for NULL). */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 288 | PyAPI_FUNC(PyThreadState *) PyThreadState_Get(void); |
Victor Stinner | bfd316e | 2016-01-20 11:12:38 +0100 | [diff] [blame] | 289 | |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 290 | #ifndef Py_LIMITED_API |
Victor Stinner | bfd316e | 2016-01-20 11:12:38 +0100 | [diff] [blame] | 291 | /* Similar to PyThreadState_Get(), but don't issue a fatal error |
| 292 | * if it is NULL. */ |
| 293 | PyAPI_FUNC(PyThreadState *) _PyThreadState_UncheckedGet(void); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 294 | #endif /* !Py_LIMITED_API */ |
Victor Stinner | bfd316e | 2016-01-20 11:12:38 +0100 | [diff] [blame] | 295 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 296 | PyAPI_FUNC(PyThreadState *) PyThreadState_Swap(PyThreadState *); |
| 297 | PyAPI_FUNC(PyObject *) PyThreadState_GetDict(void); |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 298 | PyAPI_FUNC(int) PyThreadState_SetAsyncExc(unsigned long, PyObject *); |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 299 | |
Guido van Rossum | 275ea67 | 1998-12-21 18:28:10 +0000 | [diff] [blame] | 300 | |
| 301 | /* Variable and macro for in-line access to current thread state */ |
| 302 | |
Jeffrey Yasskin | 3937083 | 2010-05-03 19:29:34 +0000 | [diff] [blame] | 303 | /* Assuming the current thread holds the GIL, this is the |
Victor Stinner | 6df29ad | 2015-09-18 15:06:34 +0200 | [diff] [blame] | 304 | PyThreadState for the current thread. */ |
| 305 | #ifdef Py_BUILD_CORE |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 306 | # define _PyThreadState_Current _PyRuntime.gilstate.tstate_current |
Victor Stinner | 6df29ad | 2015-09-18 15:06:34 +0200 | [diff] [blame] | 307 | # define PyThreadState_GET() \ |
| 308 | ((PyThreadState*)_Py_atomic_load_relaxed(&_PyThreadState_Current)) |
Guido van Rossum | 275ea67 | 1998-12-21 18:28:10 +0000 | [diff] [blame] | 309 | #else |
Victor Stinner | 6df29ad | 2015-09-18 15:06:34 +0200 | [diff] [blame] | 310 | # define PyThreadState_GET() PyThreadState_Get() |
Guido van Rossum | 275ea67 | 1998-12-21 18:28:10 +0000 | [diff] [blame] | 311 | #endif |
| 312 | |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 313 | typedef |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 314 | enum {PyGILState_LOCKED, PyGILState_UNLOCKED} |
| 315 | PyGILState_STATE; |
| 316 | |
Victor Stinner | 8e4d407 | 2011-04-26 23:34:58 +0200 | [diff] [blame] | 317 | |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 318 | /* Ensure that the current thread is ready to call the Python |
| 319 | C API, regardless of the current state of Python, or of its |
| 320 | thread lock. This may be called as many times as desired |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 321 | by a thread so long as each call is matched with a call to |
| 322 | PyGILState_Release(). In general, other thread-state APIs may |
| 323 | be used between _Ensure() and _Release() calls, so long as the |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 324 | thread-state is restored to its previous state before the Release(). |
| 325 | For example, normal use of the Py_BEGIN_ALLOW_THREADS/ |
| 326 | Py_END_ALLOW_THREADS macros are acceptable. |
| 327 | |
| 328 | The return value is an opaque "handle" to the thread state when |
Raymond Hettinger | 4eec95a | 2004-03-13 20:45:47 +0000 | [diff] [blame] | 329 | PyGILState_Ensure() was called, and must be passed to |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 330 | PyGILState_Release() to ensure Python is left in the same state. Even |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 331 | though recursive calls are allowed, these handles can *not* be shared - |
| 332 | each unique call to PyGILState_Ensure must save the handle for its |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 333 | call to PyGILState_Release. |
| 334 | |
| 335 | When the function returns, the current thread will hold the GIL. |
| 336 | |
| 337 | Failure is a fatal error. |
| 338 | */ |
| 339 | PyAPI_FUNC(PyGILState_STATE) PyGILState_Ensure(void); |
| 340 | |
| 341 | /* Release any resources previously acquired. After this call, Python's |
| 342 | state will be the same as it was prior to the corresponding |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 343 | PyGILState_Ensure() call (but generally this state will be unknown to |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 344 | the caller, hence the use of the GILState API.) |
| 345 | |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 346 | Every call to PyGILState_Ensure must be matched by a call to |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 347 | PyGILState_Release on the same thread. |
| 348 | */ |
| 349 | PyAPI_FUNC(void) PyGILState_Release(PyGILState_STATE); |
| 350 | |
| 351 | /* Helper/diagnostic function - get the current thread state for |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 352 | this thread. May return NULL if no GILState API has been used |
Sandro Tosi | 61baee0 | 2011-08-08 00:16:54 +0200 | [diff] [blame] | 353 | 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] | 354 | thread-state, even if no auto-thread-state call has been made |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 355 | on the main thread. |
| 356 | */ |
| 357 | PyAPI_FUNC(PyThreadState *) PyGILState_GetThisThreadState(void); |
| 358 | |
Martin v. Löwis | 1c0689c | 2014-01-03 21:36:49 +0100 | [diff] [blame] | 359 | #ifndef Py_LIMITED_API |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 360 | /* Helper/diagnostic function - return 1 if the current thread |
| 361 | currently holds the GIL, 0 otherwise. |
| 362 | |
| 363 | 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] | 364 | PyAPI_FUNC(int) PyGILState_Check(void); |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 365 | |
| 366 | /* Unsafe function to get the single PyInterpreterState used by this process' |
| 367 | GILState implementation. |
| 368 | |
| 369 | Return NULL before _PyGILState_Init() is called and after _PyGILState_Fini() |
| 370 | is called. */ |
| 371 | PyAPI_FUNC(PyInterpreterState *) _PyGILState_GetInterpreterStateUnsafe(void); |
Victor Stinner | 6bf992a | 2017-12-06 17:26:10 +0100 | [diff] [blame] | 372 | #endif /* !Py_LIMITED_API */ |
Kristján Valur Jónsson | 684cd0e | 2013-03-23 03:36:16 -0700 | [diff] [blame] | 373 | |
Victor Stinner | 8e4d407 | 2011-04-26 23:34:58 +0200 | [diff] [blame] | 374 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 375 | /* The implementation of sys._current_frames() Returns a dict mapping |
| 376 | thread id to that thread's current frame. |
| 377 | */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 378 | #ifndef Py_LIMITED_API |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 379 | PyAPI_FUNC(PyObject *) _PyThread_CurrentFrames(void); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 380 | #endif |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 381 | |
Guido van Rossum | f5df46d | 2001-07-19 12:19:27 +0000 | [diff] [blame] | 382 | /* Routines for advanced debuggers, requested by David Beazley. |
| 383 | Don't use unless you know what you are doing! */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 384 | #ifndef Py_LIMITED_API |
Eric Snow | 6b4be19 | 2017-05-22 21:36:03 -0700 | [diff] [blame] | 385 | PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_Main(void); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 386 | PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_Head(void); |
| 387 | PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_Next(PyInterpreterState *); |
| 388 | PyAPI_FUNC(PyThreadState *) PyInterpreterState_ThreadHead(PyInterpreterState *); |
| 389 | PyAPI_FUNC(PyThreadState *) PyThreadState_Next(PyThreadState *); |
Guido van Rossum | f5df46d | 2001-07-19 12:19:27 +0000 | [diff] [blame] | 390 | |
Guido van Rossum | 6297a7a | 2003-02-19 15:53:17 +0000 | [diff] [blame] | 391 | typedef struct _frame *(*PyThreadFrameGetter)(PyThreadState *self_); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 392 | #endif |
Guido van Rossum | 6297a7a | 2003-02-19 15:53:17 +0000 | [diff] [blame] | 393 | |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 394 | #ifdef __cplusplus |
| 395 | } |
| 396 | #endif |
| 397 | #endif /* !Py_PYSTATE_H */ |