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