Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 1 | #ifndef Py_CEVAL_H |
| 2 | #define Py_CEVAL_H |
| 3 | #ifdef __cplusplus |
| 4 | extern "C" { |
| 5 | #endif |
| 6 | |
Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 7 | |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 8 | /* Interface to random parts in ceval.c */ |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 9 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 10 | PyAPI_FUNC(PyObject *) PyEval_CallObjectWithKeywords( |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 11 | PyObject *, PyObject *, PyObject *); |
Guido van Rossum | a049031 | 1991-07-27 21:33:03 +0000 | [diff] [blame] | 12 | |
Guido van Rossum | d7ed683 | 1997-08-30 15:02:50 +0000 | [diff] [blame] | 13 | /* Inline this */ |
| 14 | #define PyEval_CallObject(func,arg) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 15 | PyEval_CallObjectWithKeywords(func, arg, (PyObject *)NULL) |
Guido van Rossum | d7ed683 | 1997-08-30 15:02:50 +0000 | [diff] [blame] | 16 | |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 17 | PyAPI_FUNC(PyObject *) PyEval_CallFunction(PyObject *obj, |
| 18 | const char *format, ...); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 19 | PyAPI_FUNC(PyObject *) PyEval_CallMethod(PyObject *obj, |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 20 | const char *methodname, |
| 21 | const char *format, ...); |
Guido van Rossum | 3d109a0 | 1998-08-08 20:53:36 +0000 | [diff] [blame] | 22 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 23 | #ifndef Py_LIMITED_API |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 24 | PyAPI_FUNC(void) PyEval_SetProfile(Py_tracefunc, PyObject *); |
| 25 | PyAPI_FUNC(void) PyEval_SetTrace(Py_tracefunc, PyObject *); |
Yury Selivanov | aab3c4a | 2015-06-02 18:43:51 -0400 | [diff] [blame] | 26 | PyAPI_FUNC(void) _PyEval_SetCoroutineWrapper(PyObject *); |
Yury Selivanov | d8cf382 | 2015-06-01 12:15:23 -0400 | [diff] [blame] | 27 | PyAPI_FUNC(PyObject *) _PyEval_GetCoroutineWrapper(void); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 28 | #endif |
Fred Drake | 55fb6e0 | 2001-06-27 19:18:03 +0000 | [diff] [blame] | 29 | |
Guido van Rossum | 6297a7a | 2003-02-19 15:53:17 +0000 | [diff] [blame] | 30 | struct _frame; /* Avoid including frameobject.h */ |
| 31 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 32 | PyAPI_FUNC(PyObject *) PyEval_GetBuiltins(void); |
| 33 | PyAPI_FUNC(PyObject *) PyEval_GetGlobals(void); |
| 34 | PyAPI_FUNC(PyObject *) PyEval_GetLocals(void); |
Guido van Rossum | 6297a7a | 2003-02-19 15:53:17 +0000 | [diff] [blame] | 35 | PyAPI_FUNC(struct _frame *) PyEval_GetFrame(void); |
Tim Peters | 5ba5866 | 2001-07-16 02:29:45 +0000 | [diff] [blame] | 36 | |
| 37 | /* Look at the current frame's (if any) code's co_flags, and turn on |
| 38 | the corresponding compiler flags in cf->cf_flags. Return 1 if any |
| 39 | flag was set, else return 0. */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 40 | #ifndef Py_LIMITED_API |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 41 | PyAPI_FUNC(int) PyEval_MergeCompilerFlags(PyCompilerFlags *cf); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 42 | #endif |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 43 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 44 | PyAPI_FUNC(int) Py_AddPendingCall(int (*func)(void *), void *arg); |
| 45 | PyAPI_FUNC(int) Py_MakePendingCalls(void); |
Guido van Rossum | 9566408 | 1994-09-14 13:23:36 +0000 | [diff] [blame] | 46 | |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 47 | /* Protection against deeply nested recursive calls |
| 48 | |
| 49 | In Python 3.0, this protection has two levels: |
| 50 | * normal anti-recursion protection is triggered when the recursion level |
Yury Selivanov | f488fb4 | 2015-07-03 01:04:23 -0400 | [diff] [blame] | 51 | exceeds the current recursion limit. It raises a RecursionError, and sets |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 52 | the "overflowed" flag in the thread state structure. This flag |
| 53 | temporarily *disables* the normal protection; this allows cleanup code |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 54 | to potentially outgrow the recursion limit while processing the |
Yury Selivanov | f488fb4 | 2015-07-03 01:04:23 -0400 | [diff] [blame] | 55 | RecursionError. |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 56 | * "last chance" anti-recursion protection is triggered when the recursion |
| 57 | level exceeds "current recursion limit + 50". By construction, this |
| 58 | protection can only be triggered when the "overflowed" flag is set. It |
| 59 | means the cleanup code has itself gone into an infinite loop, or the |
Yury Selivanov | f488fb4 | 2015-07-03 01:04:23 -0400 | [diff] [blame] | 60 | RecursionError has been mistakingly ignored. When this protection is |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 61 | triggered, the interpreter aborts with a Fatal Error. |
| 62 | |
| 63 | In addition, the "overflowed" flag is automatically reset when the |
| 64 | recursion level drops below "current recursion limit - 50". This heuristic |
| 65 | is meant to ensure that the normal anti-recursion protection doesn't get |
| 66 | disabled too long. |
| 67 | |
| 68 | Please note: this scheme has its own limitations. See: |
| 69 | http://mail.python.org/pipermail/python-dev/2008-August/082106.html |
| 70 | for some observations. |
| 71 | */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 72 | PyAPI_FUNC(void) Py_SetRecursionLimit(int); |
| 73 | PyAPI_FUNC(int) Py_GetRecursionLimit(void); |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 74 | |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 75 | #define Py_EnterRecursiveCall(where) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 76 | (_Py_MakeRecCheck(PyThreadState_GET()->recursion_depth) && \ |
| 77 | _Py_CheckRecursiveCall(where)) |
| 78 | #define Py_LeaveRecursiveCall() \ |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 79 | do{ if(_Py_MakeEndRecCheck(PyThreadState_GET()->recursion_depth)) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 80 | PyThreadState_GET()->overflowed = 0; \ |
| 81 | } while(0) |
Serhiy Storchaka | 5fa22fc | 2015-06-21 16:26:28 +0300 | [diff] [blame] | 82 | PyAPI_FUNC(int) _Py_CheckRecursiveCall(const char *where); |
Armin Rigo | 2b3eb40 | 2003-10-28 12:05:48 +0000 | [diff] [blame] | 83 | PyAPI_DATA(int) _Py_CheckRecursionLimit; |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 84 | |
Armin Rigo | 2b3eb40 | 2003-10-28 12:05:48 +0000 | [diff] [blame] | 85 | #ifdef USE_STACKCHECK |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 86 | /* With USE_STACKCHECK, we artificially decrement the recursion limit in order |
| 87 | to trigger regular stack checks in _Py_CheckRecursiveCall(), except if |
| 88 | the "overflowed" flag is set, in which case we need the true value |
| 89 | of _Py_CheckRecursionLimit for _Py_MakeEndRecCheck() to function properly. |
| 90 | */ |
| 91 | # define _Py_MakeRecCheck(x) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 92 | (++(x) > (_Py_CheckRecursionLimit += PyThreadState_GET()->overflowed - 1)) |
Armin Rigo | 2b3eb40 | 2003-10-28 12:05:48 +0000 | [diff] [blame] | 93 | #else |
| 94 | # define _Py_MakeRecCheck(x) (++(x) > _Py_CheckRecursionLimit) |
| 95 | #endif |
| 96 | |
Victor Stinner | 50856d5 | 2015-10-13 00:11:21 +0200 | [diff] [blame] | 97 | /* Compute the "lower-water mark" for a recursion limit. When |
| 98 | * Py_LeaveRecursiveCall() is called with a recursion depth below this mark, |
| 99 | * the overflowed flag is reset to 0. */ |
| 100 | #define _Py_RecursionLimitLowerWaterMark(limit) \ |
| 101 | (((limit) > 200) \ |
| 102 | ? ((limit) - 50) \ |
| 103 | : (3 * ((limit) >> 2))) |
| 104 | |
Antoine Pitrou | 652e707 | 2009-03-13 19:25:20 +0000 | [diff] [blame] | 105 | #define _Py_MakeEndRecCheck(x) \ |
Victor Stinner | 50856d5 | 2015-10-13 00:11:21 +0200 | [diff] [blame] | 106 | (--(x) < _Py_RecursionLimitLowerWaterMark(_Py_CheckRecursionLimit)) |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 107 | |
Martin v. Löwis | 5b22213 | 2007-06-10 09:51:05 +0000 | [diff] [blame] | 108 | #define Py_ALLOW_RECURSION \ |
| 109 | do { unsigned char _old = PyThreadState_GET()->recursion_critical;\ |
| 110 | PyThreadState_GET()->recursion_critical = 1; |
| 111 | |
| 112 | #define Py_END_ALLOW_RECURSION \ |
| 113 | PyThreadState_GET()->recursion_critical = _old; \ |
| 114 | } while(0); |
| 115 | |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 116 | PyAPI_FUNC(const char *) PyEval_GetFuncName(PyObject *); |
| 117 | PyAPI_FUNC(const char *) PyEval_GetFuncDesc(PyObject *); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 118 | |
Jeremy Hylton | 985eba5 | 2003-02-05 23:13:00 +0000 | [diff] [blame] | 119 | PyAPI_FUNC(PyObject *) PyEval_GetCallStats(PyObject *); |
Martin v. Löwis | 8d97e33 | 2004-06-27 15:43:12 +0000 | [diff] [blame] | 120 | PyAPI_FUNC(PyObject *) PyEval_EvalFrame(struct _frame *); |
Phillip J. Eby | 0d6615f | 2005-08-02 00:46:46 +0000 | [diff] [blame] | 121 | PyAPI_FUNC(PyObject *) PyEval_EvalFrameEx(struct _frame *f, int exc); |
Jeremy Hylton | 985eba5 | 2003-02-05 23:13:00 +0000 | [diff] [blame] | 122 | |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 123 | /* Interface for threads. |
| 124 | |
| 125 | A module that plans to do a blocking system call (or something else |
| 126 | that lasts a long time and doesn't touch Python data) can allow other |
| 127 | threads to run as follows: |
| 128 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 129 | ...preparations here... |
| 130 | Py_BEGIN_ALLOW_THREADS |
| 131 | ...blocking system call here... |
| 132 | Py_END_ALLOW_THREADS |
| 133 | ...interpret result here... |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 134 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 135 | The Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS pair expands to a |
| 136 | {}-surrounded block. |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 137 | To leave the block in the middle (e.g., with return), you must insert |
Skip Montanaro | 682c25a | 2000-09-15 18:19:27 +0000 | [diff] [blame] | 138 | a line containing Py_BLOCK_THREADS before the return, e.g. |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 139 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 140 | if (...premature_exit...) { |
| 141 | Py_BLOCK_THREADS |
| 142 | PyErr_SetFromErrno(PyExc_IOError); |
| 143 | return NULL; |
| 144 | } |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 145 | |
| 146 | An alternative is: |
| 147 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 148 | Py_BLOCK_THREADS |
| 149 | if (...premature_exit...) { |
| 150 | PyErr_SetFromErrno(PyExc_IOError); |
| 151 | return NULL; |
| 152 | } |
| 153 | Py_UNBLOCK_THREADS |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 154 | |
| 155 | For convenience, that the value of 'errno' is restored across |
Skip Montanaro | 682c25a | 2000-09-15 18:19:27 +0000 | [diff] [blame] | 156 | Py_END_ALLOW_THREADS and Py_BLOCK_THREADS. |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 157 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 158 | WARNING: NEVER NEST CALLS TO Py_BEGIN_ALLOW_THREADS AND |
| 159 | Py_END_ALLOW_THREADS!!! |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 160 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 161 | The function PyEval_InitThreads() should be called only from |
Georg Brandl | 2067bfd | 2008-05-25 13:05:15 +0000 | [diff] [blame] | 162 | init_thread() in "_threadmodule.c". |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 163 | |
| 164 | Note that not yet all candidates have been converted to use this |
| 165 | mechanism! |
| 166 | */ |
| 167 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 168 | PyAPI_FUNC(PyThreadState *) PyEval_SaveThread(void); |
| 169 | PyAPI_FUNC(void) PyEval_RestoreThread(PyThreadState *); |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 170 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 171 | #ifdef WITH_THREAD |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 172 | |
Tim Peters | 7f468f2 | 2004-10-11 02:40:51 +0000 | [diff] [blame] | 173 | PyAPI_FUNC(int) PyEval_ThreadsInitialized(void); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 174 | PyAPI_FUNC(void) PyEval_InitThreads(void); |
Antoine Pitrou | 1df1536 | 2010-09-13 14:16:46 +0000 | [diff] [blame] | 175 | PyAPI_FUNC(void) _PyEval_FiniThreads(void); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 176 | PyAPI_FUNC(void) PyEval_AcquireLock(void); |
| 177 | PyAPI_FUNC(void) PyEval_ReleaseLock(void); |
| 178 | PyAPI_FUNC(void) PyEval_AcquireThread(PyThreadState *tstate); |
| 179 | PyAPI_FUNC(void) PyEval_ReleaseThread(PyThreadState *tstate); |
| 180 | PyAPI_FUNC(void) PyEval_ReInitThreads(void); |
Guido van Rossum | 2fca21f7 | 1997-07-18 23:56:58 +0000 | [diff] [blame] | 181 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 182 | #ifndef Py_LIMITED_API |
Antoine Pitrou | 074e5ed | 2009-11-10 19:50:40 +0000 | [diff] [blame] | 183 | PyAPI_FUNC(void) _PyEval_SetSwitchInterval(unsigned long microseconds); |
| 184 | PyAPI_FUNC(unsigned long) _PyEval_GetSwitchInterval(void); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 185 | #endif |
Antoine Pitrou | 074e5ed | 2009-11-10 19:50:40 +0000 | [diff] [blame] | 186 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 187 | #define Py_BEGIN_ALLOW_THREADS { \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 188 | PyThreadState *_save; \ |
| 189 | _save = PyEval_SaveThread(); |
| 190 | #define Py_BLOCK_THREADS PyEval_RestoreThread(_save); |
| 191 | #define Py_UNBLOCK_THREADS _save = PyEval_SaveThread(); |
| 192 | #define Py_END_ALLOW_THREADS PyEval_RestoreThread(_save); \ |
| 193 | } |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 194 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 195 | #else /* !WITH_THREAD */ |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 196 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 197 | #define Py_BEGIN_ALLOW_THREADS { |
| 198 | #define Py_BLOCK_THREADS |
| 199 | #define Py_UNBLOCK_THREADS |
| 200 | #define Py_END_ALLOW_THREADS } |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 201 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 202 | #endif /* !WITH_THREAD */ |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 203 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 204 | #ifndef Py_LIMITED_API |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 205 | PyAPI_FUNC(int) _PyEval_SliceIndex(PyObject *, Py_ssize_t *); |
Antoine Pitrou | 074e5ed | 2009-11-10 19:50:40 +0000 | [diff] [blame] | 206 | PyAPI_FUNC(void) _PyEval_SignalAsyncExc(void); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 207 | #endif |
Guido van Rossum | 7c36ada | 2000-05-08 14:04:54 +0000 | [diff] [blame] | 208 | |
| 209 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 210 | #ifdef __cplusplus |
| 211 | } |
| 212 | #endif |
| 213 | #endif /* !Py_CEVAL_H */ |