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