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 | |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 11 | /* State shared between threads */ |
| 12 | |
Guido van Rossum | 29e46a9 | 1997-08-02 02:56:48 +0000 | [diff] [blame] | 13 | struct _ts; /* Forward */ |
| 14 | struct _is; /* Forward */ |
| 15 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 16 | #ifdef Py_LIMITED_API |
| 17 | typedef struct _is PyInterpreterState; |
| 18 | #else |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 19 | typedef struct _is { |
| 20 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 21 | struct _is *next; |
| 22 | struct _ts *tstate_head; |
Guido van Rossum | 29e46a9 | 1997-08-02 02:56:48 +0000 | [diff] [blame] | 23 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 24 | PyObject *modules; |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 25 | PyObject *modules_by_index; |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 26 | PyObject *sysdict; |
| 27 | PyObject *builtins; |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 28 | PyObject *modules_reloading; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 29 | |
Gustavo Niemeyer | 5ddd4c3 | 2003-03-19 00:35:36 +0000 | [diff] [blame] | 30 | PyObject *codec_search_path; |
| 31 | PyObject *codec_search_cache; |
| 32 | PyObject *codec_error_registry; |
Christian Heimes | 6a27efa | 2008-10-30 21:48:26 +0000 | [diff] [blame] | 33 | int codecs_initialized; |
Victor Stinner | 793b531 | 2011-04-27 00:24:21 +0200 | [diff] [blame] | 34 | int fscodec_initialized; |
Gustavo Niemeyer | 5ddd4c3 | 2003-03-19 00:35:36 +0000 | [diff] [blame] | 35 | |
Martin v. Löwis | f0473d5 | 2001-07-18 16:17:16 +0000 | [diff] [blame] | 36 | #ifdef HAVE_DLOPEN |
| 37 | int dlopenflags; |
| 38 | #endif |
Martin v. Löwis | f30d60e | 2004-06-08 08:17:44 +0000 | [diff] [blame] | 39 | #ifdef WITH_TSC |
| 40 | int tscdump; |
| 41 | #endif |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 42 | |
| 43 | } PyInterpreterState; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 44 | #endif |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 45 | |
| 46 | |
| 47 | /* State unique per thread */ |
| 48 | |
| 49 | struct _frame; /* Avoid including frameobject.h */ |
| 50 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 51 | #ifndef Py_LIMITED_API |
Fred Drake | 55fb6e0 | 2001-06-27 19:18:03 +0000 | [diff] [blame] | 52 | /* Py_tracefunc return -1 when raising an exception, or 0 for success. */ |
| 53 | typedef int (*Py_tracefunc)(PyObject *, struct _frame *, int, PyObject *); |
| 54 | |
| 55 | /* The following values are used for 'what' for tracefunc functions: */ |
| 56 | #define PyTrace_CALL 0 |
| 57 | #define PyTrace_EXCEPTION 1 |
| 58 | #define PyTrace_LINE 2 |
| 59 | #define PyTrace_RETURN 3 |
Nicholas Bastin | c69ebe8 | 2004-03-24 21:57:10 +0000 | [diff] [blame] | 60 | #define PyTrace_C_CALL 4 |
| 61 | #define PyTrace_C_EXCEPTION 5 |
| 62 | #define PyTrace_C_RETURN 6 |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 63 | #endif |
Fred Drake | 55fb6e0 | 2001-06-27 19:18:03 +0000 | [diff] [blame] | 64 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 65 | #ifdef Py_LIMITED_API |
| 66 | typedef struct _ts PyThreadState; |
| 67 | #else |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 68 | typedef struct _ts { |
Brett Cannon | 55fa66d | 2005-06-25 07:07:35 +0000 | [diff] [blame] | 69 | /* See Python/ceval.c for comments explaining most fields */ |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 70 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 71 | struct _ts *next; |
| 72 | PyInterpreterState *interp; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 73 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 74 | struct _frame *frame; |
| 75 | int recursion_depth; |
Martin v. Löwis | 5b22213 | 2007-06-10 09:51:05 +0000 | [diff] [blame] | 76 | char overflowed; /* The stack has overflowed. Allow 50 more calls |
Victor Stinner | 8e4d407 | 2011-04-26 23:34:58 +0200 | [diff] [blame] | 77 | to handle the runtime error. */ |
| 78 | char recursion_critical; /* The current calls must not cause |
| 79 | a stack overflow. */ |
Brett Cannon | 55fa66d | 2005-06-25 07:07:35 +0000 | [diff] [blame] | 80 | /* 'tracing' keeps track of the execution depth when tracing/profiling. |
| 81 | This is to prevent the actual trace/profile code from being recorded in |
| 82 | the trace/profile. */ |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 83 | int tracing; |
Fred Drake | 9e3ad78 | 2001-07-03 23:39:52 +0000 | [diff] [blame] | 84 | int use_tracing; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 85 | |
Fred Drake | 55fb6e0 | 2001-06-27 19:18:03 +0000 | [diff] [blame] | 86 | Py_tracefunc c_profilefunc; |
| 87 | Py_tracefunc c_tracefunc; |
| 88 | PyObject *c_profileobj; |
| 89 | PyObject *c_traceobj; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 90 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 91 | PyObject *curexc_type; |
| 92 | PyObject *curexc_value; |
| 93 | PyObject *curexc_traceback; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 94 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 95 | PyObject *exc_type; |
| 96 | PyObject *exc_value; |
| 97 | PyObject *exc_traceback; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 98 | |
Brett Cannon | 55fa66d | 2005-06-25 07:07:35 +0000 | [diff] [blame] | 99 | PyObject *dict; /* Stores per-thread state */ |
Guido van Rossum | ee0a63b | 1998-04-13 20:24:05 +0000 | [diff] [blame] | 100 | |
Antoine Pitrou | 074e5ed | 2009-11-10 19:50:40 +0000 | [diff] [blame] | 101 | /* XXX doesn't mean anything anymore (the comment below is obsolete) |
| 102 | => deprecate or remove? */ |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 103 | /* tick_counter is incremented whenever the check_interval ticker |
| 104 | * reaches zero. The purpose is to give a useful measure of the number |
| 105 | * of interpreted bytecode instructions in a given thread. This |
| 106 | * extremely lightweight statistic collector may be of interest to |
| 107 | * profilers (like psyco.jit()), although nothing in the core uses it. |
| 108 | */ |
Michael W. Hudson | 019a78e | 2002-11-08 12:53:11 +0000 | [diff] [blame] | 109 | int tick_counter; |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 110 | |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 111 | int gilstate_counter; |
Michael W. Hudson | 019a78e | 2002-11-08 12:53:11 +0000 | [diff] [blame] | 112 | |
Guido van Rossum | b8b6d0c | 2003-06-28 21:53:52 +0000 | [diff] [blame] | 113 | PyObject *async_exc; /* Asynchronous exception to raise */ |
| 114 | long thread_id; /* Thread id where this tstate was created */ |
| 115 | |
Fred Drake | 5eb6d4e | 2000-07-08 23:37:28 +0000 | [diff] [blame] | 116 | /* XXX signal handlers should also be here */ |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 117 | |
| 118 | } PyThreadState; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 119 | #endif |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 120 | |
| 121 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 122 | PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_New(void); |
| 123 | PyAPI_FUNC(void) PyInterpreterState_Clear(PyInterpreterState *); |
| 124 | PyAPI_FUNC(void) PyInterpreterState_Delete(PyInterpreterState *); |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 125 | PyAPI_FUNC(int) _PyState_AddModule(PyObject*, struct PyModuleDef*); |
| 126 | PyAPI_FUNC(PyObject*) PyState_FindModule(struct PyModuleDef*); |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 127 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 128 | PyAPI_FUNC(PyThreadState *) PyThreadState_New(PyInterpreterState *); |
Victor Stinner | 45b9be5 | 2010-03-03 23:28:07 +0000 | [diff] [blame] | 129 | PyAPI_FUNC(PyThreadState *) _PyThreadState_Prealloc(PyInterpreterState *); |
| 130 | PyAPI_FUNC(void) _PyThreadState_Init(PyThreadState *); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 131 | PyAPI_FUNC(void) PyThreadState_Clear(PyThreadState *); |
| 132 | PyAPI_FUNC(void) PyThreadState_Delete(PyThreadState *); |
Guido van Rossum | 2975786 | 2001-01-23 01:46:06 +0000 | [diff] [blame] | 133 | #ifdef WITH_THREAD |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 134 | PyAPI_FUNC(void) PyThreadState_DeleteCurrent(void); |
Antoine Pitrou | 0c759fe | 2011-04-27 19:28:05 +0200 | [diff] [blame] | 135 | PyAPI_FUNC(void) _PyGILState_Reinit(void); |
Guido van Rossum | 2975786 | 2001-01-23 01:46:06 +0000 | [diff] [blame] | 136 | #endif |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 137 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 138 | PyAPI_FUNC(PyThreadState *) PyThreadState_Get(void); |
| 139 | PyAPI_FUNC(PyThreadState *) PyThreadState_Swap(PyThreadState *); |
| 140 | PyAPI_FUNC(PyObject *) PyThreadState_GetDict(void); |
Guido van Rossum | b8b6d0c | 2003-06-28 21:53:52 +0000 | [diff] [blame] | 141 | PyAPI_FUNC(int) PyThreadState_SetAsyncExc(long, PyObject *); |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 142 | |
Guido van Rossum | 275ea67 | 1998-12-21 18:28:10 +0000 | [diff] [blame] | 143 | |
| 144 | /* Variable and macro for in-line access to current thread state */ |
| 145 | |
Jeffrey Yasskin | 3937083 | 2010-05-03 19:29:34 +0000 | [diff] [blame] | 146 | /* Assuming the current thread holds the GIL, this is the |
| 147 | PyThreadState for the current thread. */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 148 | #ifndef Py_LIMITED_API |
Jeffrey Yasskin | 3937083 | 2010-05-03 19:29:34 +0000 | [diff] [blame] | 149 | PyAPI_DATA(_Py_atomic_address) _PyThreadState_Current; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 150 | #endif |
Guido van Rossum | 275ea67 | 1998-12-21 18:28:10 +0000 | [diff] [blame] | 151 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 152 | #if defined(Py_DEBUG) || defined(Py_LIMITED_API) |
Guido van Rossum | 275ea67 | 1998-12-21 18:28:10 +0000 | [diff] [blame] | 153 | #define PyThreadState_GET() PyThreadState_Get() |
| 154 | #else |
Jeffrey Yasskin | 3937083 | 2010-05-03 19:29:34 +0000 | [diff] [blame] | 155 | #define PyThreadState_GET() \ |
| 156 | ((PyThreadState*)_Py_atomic_load_relaxed(&_PyThreadState_Current)) |
Guido van Rossum | 275ea67 | 1998-12-21 18:28:10 +0000 | [diff] [blame] | 157 | #endif |
| 158 | |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 159 | typedef |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 160 | enum {PyGILState_LOCKED, PyGILState_UNLOCKED} |
| 161 | PyGILState_STATE; |
| 162 | |
Victor Stinner | 8e4d407 | 2011-04-26 23:34:58 +0200 | [diff] [blame] | 163 | #ifdef WITH_THREAD |
| 164 | |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 165 | /* Ensure that the current thread is ready to call the Python |
| 166 | C API, regardless of the current state of Python, or of its |
| 167 | thread lock. This may be called as many times as desired |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 168 | by a thread so long as each call is matched with a call to |
| 169 | PyGILState_Release(). In general, other thread-state APIs may |
| 170 | be used between _Ensure() and _Release() calls, so long as the |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 171 | thread-state is restored to its previous state before the Release(). |
| 172 | For example, normal use of the Py_BEGIN_ALLOW_THREADS/ |
| 173 | Py_END_ALLOW_THREADS macros are acceptable. |
| 174 | |
| 175 | The return value is an opaque "handle" to the thread state when |
Raymond Hettinger | 4eec95a | 2004-03-13 20:45:47 +0000 | [diff] [blame] | 176 | PyGILState_Ensure() was called, and must be passed to |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 177 | PyGILState_Release() to ensure Python is left in the same state. Even |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 178 | though recursive calls are allowed, these handles can *not* be shared - |
| 179 | each unique call to PyGILState_Ensure must save the handle for its |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 180 | call to PyGILState_Release. |
| 181 | |
| 182 | When the function returns, the current thread will hold the GIL. |
| 183 | |
| 184 | Failure is a fatal error. |
| 185 | */ |
| 186 | PyAPI_FUNC(PyGILState_STATE) PyGILState_Ensure(void); |
| 187 | |
| 188 | /* Release any resources previously acquired. After this call, Python's |
| 189 | state will be the same as it was prior to the corresponding |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 190 | PyGILState_Ensure() call (but generally this state will be unknown to |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 191 | the caller, hence the use of the GILState API.) |
| 192 | |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 193 | Every call to PyGILState_Ensure must be matched by a call to |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 194 | PyGILState_Release on the same thread. |
| 195 | */ |
| 196 | PyAPI_FUNC(void) PyGILState_Release(PyGILState_STATE); |
| 197 | |
| 198 | /* Helper/diagnostic function - get the current thread state for |
Tim Peters | 174175b | 2004-03-29 02:24:26 +0000 | [diff] [blame] | 199 | this thread. May return NULL if no GILState API has been used |
| 200 | on the current thread. Note the main thread always has such a |
| 201 | thread-state, even if no auto-thread-state call has been made |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 202 | on the main thread. |
| 203 | */ |
| 204 | PyAPI_FUNC(PyThreadState *) PyGILState_GetThisThreadState(void); |
| 205 | |
Victor Stinner | 8e4d407 | 2011-04-26 23:34:58 +0200 | [diff] [blame] | 206 | #endif /* #ifdef WITH_THREAD */ |
| 207 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 208 | /* The implementation of sys._current_frames() Returns a dict mapping |
| 209 | thread id to that thread's current frame. |
| 210 | */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 211 | #ifndef Py_LIMITED_API |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 212 | PyAPI_FUNC(PyObject *) _PyThread_CurrentFrames(void); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 213 | #endif |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 214 | |
Guido van Rossum | f5df46d | 2001-07-19 12:19:27 +0000 | [diff] [blame] | 215 | /* Routines for advanced debuggers, requested by David Beazley. |
| 216 | Don't use unless you know what you are doing! */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 217 | #ifndef Py_LIMITED_API |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 218 | PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_Head(void); |
| 219 | PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_Next(PyInterpreterState *); |
| 220 | PyAPI_FUNC(PyThreadState *) PyInterpreterState_ThreadHead(PyInterpreterState *); |
| 221 | PyAPI_FUNC(PyThreadState *) PyThreadState_Next(PyThreadState *); |
Guido van Rossum | f5df46d | 2001-07-19 12:19:27 +0000 | [diff] [blame] | 222 | |
Guido van Rossum | 6297a7a | 2003-02-19 15:53:17 +0000 | [diff] [blame] | 223 | typedef struct _frame *(*PyThreadFrameGetter)(PyThreadState *self_); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 224 | #endif |
Guido van Rossum | 6297a7a | 2003-02-19 15:53:17 +0000 | [diff] [blame] | 225 | |
Michael W. Hudson | 019a78e | 2002-11-08 12:53:11 +0000 | [diff] [blame] | 226 | /* hook for PyEval_GetFrame(), requested for Psyco */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 227 | #ifndef Py_LIMITED_API |
Guido van Rossum | 6297a7a | 2003-02-19 15:53:17 +0000 | [diff] [blame] | 228 | PyAPI_DATA(PyThreadFrameGetter) _PyThreadState_GetFrame; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 229 | #endif |
Michael W. Hudson | 019a78e | 2002-11-08 12:53:11 +0000 | [diff] [blame] | 230 | |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 231 | #ifdef __cplusplus |
| 232 | } |
| 233 | #endif |
| 234 | #endif /* !Py_PYSTATE_H */ |