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 | |
INADA Naoki | aa289a5 | 2017-03-14 18:00:59 +0900 | [diff] [blame] | 10 | /* PyEval_CallObjectWithKeywords(), PyEval_CallObject(), PyEval_CallFunction |
Jeroen Demeyer | 151b91d | 2019-07-24 14:02:49 +0200 | [diff] [blame] | 11 | * and PyEval_CallMethod are deprecated. Since they are officially part of the |
| 12 | * stable ABI (PEP 384), they must be kept for backward compatibility. |
| 13 | * PyObject_Call(), PyObject_CallFunction() and PyObject_CallMethod() are |
| 14 | * recommended to call a callable object. |
INADA Naoki | aa289a5 | 2017-03-14 18:00:59 +0900 | [diff] [blame] | 15 | */ |
| 16 | |
Jeroen Demeyer | 151b91d | 2019-07-24 14:02:49 +0200 | [diff] [blame] | 17 | Py_DEPRECATED(3.9) PyAPI_FUNC(PyObject *) PyEval_CallObjectWithKeywords( |
Victor Stinner | 2d0eb65 | 2016-12-06 16:27:24 +0100 | [diff] [blame] | 18 | PyObject *callable, |
| 19 | PyObject *args, |
| 20 | PyObject *kwargs); |
Guido van Rossum | a049031 | 1991-07-27 21:33:03 +0000 | [diff] [blame] | 21 | |
Jeroen Demeyer | 151b91d | 2019-07-24 14:02:49 +0200 | [diff] [blame] | 22 | /* Deprecated since PyEval_CallObjectWithKeywords is deprecated */ |
Victor Stinner | 2d0eb65 | 2016-12-06 16:27:24 +0100 | [diff] [blame] | 23 | #define PyEval_CallObject(callable, arg) \ |
| 24 | PyEval_CallObjectWithKeywords(callable, arg, (PyObject *)NULL) |
Guido van Rossum | d7ed683 | 1997-08-30 15:02:50 +0000 | [diff] [blame] | 25 | |
Jeroen Demeyer | 151b91d | 2019-07-24 14:02:49 +0200 | [diff] [blame] | 26 | Py_DEPRECATED(3.9) PyAPI_FUNC(PyObject *) PyEval_CallFunction( |
| 27 | PyObject *callable, const char *format, ...); |
| 28 | Py_DEPRECATED(3.9) PyAPI_FUNC(PyObject *) PyEval_CallMethod( |
| 29 | PyObject *obj, const char *name, const char *format, ...); |
Guido van Rossum | 3d109a0 | 1998-08-08 20:53:36 +0000 | [diff] [blame] | 30 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 31 | PyAPI_FUNC(PyObject *) PyEval_GetBuiltins(void); |
| 32 | PyAPI_FUNC(PyObject *) PyEval_GetGlobals(void); |
| 33 | PyAPI_FUNC(PyObject *) PyEval_GetLocals(void); |
Victor Stinner | 7c59d7c | 2020-04-28 16:32:48 +0200 | [diff] [blame] | 34 | PyAPI_FUNC(PyFrameObject *) PyEval_GetFrame(void); |
Tim Peters | 5ba5866 | 2001-07-16 02:29:45 +0000 | [diff] [blame] | 35 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 36 | PyAPI_FUNC(int) Py_AddPendingCall(int (*func)(void *), void *arg); |
| 37 | PyAPI_FUNC(int) Py_MakePendingCalls(void); |
Guido van Rossum | 9566408 | 1994-09-14 13:23:36 +0000 | [diff] [blame] | 38 | |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 39 | /* Protection against deeply nested recursive calls |
| 40 | |
| 41 | In Python 3.0, this protection has two levels: |
| 42 | * normal anti-recursion protection is triggered when the recursion level |
Yury Selivanov | f488fb4 | 2015-07-03 01:04:23 -0400 | [diff] [blame] | 43 | exceeds the current recursion limit. It raises a RecursionError, and sets |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 44 | the "overflowed" flag in the thread state structure. This flag |
| 45 | temporarily *disables* the normal protection; this allows cleanup code |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 46 | to potentially outgrow the recursion limit while processing the |
Yury Selivanov | f488fb4 | 2015-07-03 01:04:23 -0400 | [diff] [blame] | 47 | RecursionError. |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 48 | * "last chance" anti-recursion protection is triggered when the recursion |
| 49 | level exceeds "current recursion limit + 50". By construction, this |
| 50 | protection can only be triggered when the "overflowed" flag is set. It |
| 51 | 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] | 52 | RecursionError has been mistakingly ignored. When this protection is |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 53 | triggered, the interpreter aborts with a Fatal Error. |
| 54 | |
| 55 | In addition, the "overflowed" flag is automatically reset when the |
| 56 | recursion level drops below "current recursion limit - 50". This heuristic |
| 57 | is meant to ensure that the normal anti-recursion protection doesn't get |
| 58 | disabled too long. |
| 59 | |
| 60 | Please note: this scheme has its own limitations. See: |
| 61 | http://mail.python.org/pipermail/python-dev/2008-August/082106.html |
| 62 | for some observations. |
| 63 | */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 64 | PyAPI_FUNC(void) Py_SetRecursionLimit(int); |
| 65 | PyAPI_FUNC(int) Py_GetRecursionLimit(void); |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 66 | |
Victor Stinner | f4b1e3d | 2019-11-04 19:48:34 +0100 | [diff] [blame] | 67 | PyAPI_FUNC(int) Py_EnterRecursiveCall(const char *where); |
| 68 | PyAPI_FUNC(void) Py_LeaveRecursiveCall(void); |
Antoine Pitrou | 658fad8 | 2008-09-03 18:34:34 +0000 | [diff] [blame] | 69 | |
Martin v. Löwis | 5b22213 | 2007-06-10 09:51:05 +0000 | [diff] [blame] | 70 | #define Py_ALLOW_RECURSION \ |
| 71 | do { unsigned char _old = PyThreadState_GET()->recursion_critical;\ |
| 72 | PyThreadState_GET()->recursion_critical = 1; |
| 73 | |
| 74 | #define Py_END_ALLOW_RECURSION \ |
| 75 | PyThreadState_GET()->recursion_critical = _old; \ |
| 76 | } while(0); |
| 77 | |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 78 | PyAPI_FUNC(const char *) PyEval_GetFuncName(PyObject *); |
| 79 | PyAPI_FUNC(const char *) PyEval_GetFuncDesc(PyObject *); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 80 | |
Victor Stinner | 7c59d7c | 2020-04-28 16:32:48 +0200 | [diff] [blame] | 81 | PyAPI_FUNC(PyObject *) PyEval_EvalFrame(PyFrameObject *); |
| 82 | PyAPI_FUNC(PyObject *) PyEval_EvalFrameEx(PyFrameObject *f, int exc); |
Jeremy Hylton | 985eba5 | 2003-02-05 23:13:00 +0000 | [diff] [blame] | 83 | |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 84 | /* Interface for threads. |
| 85 | |
| 86 | A module that plans to do a blocking system call (or something else |
| 87 | that lasts a long time and doesn't touch Python data) can allow other |
| 88 | threads to run as follows: |
| 89 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 90 | ...preparations here... |
| 91 | Py_BEGIN_ALLOW_THREADS |
| 92 | ...blocking system call here... |
| 93 | Py_END_ALLOW_THREADS |
| 94 | ...interpret result here... |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 95 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 96 | The Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS pair expands to a |
| 97 | {}-surrounded block. |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 98 | 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] | 99 | a line containing Py_BLOCK_THREADS before the return, e.g. |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 100 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 101 | if (...premature_exit...) { |
| 102 | Py_BLOCK_THREADS |
Serhiy Storchaka | 55fe1ae | 2017-04-16 10:46:38 +0300 | [diff] [blame] | 103 | PyErr_SetFromErrno(PyExc_OSError); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 104 | return NULL; |
| 105 | } |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 106 | |
| 107 | An alternative is: |
| 108 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 109 | Py_BLOCK_THREADS |
| 110 | if (...premature_exit...) { |
Serhiy Storchaka | 55fe1ae | 2017-04-16 10:46:38 +0300 | [diff] [blame] | 111 | PyErr_SetFromErrno(PyExc_OSError); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 112 | return NULL; |
| 113 | } |
| 114 | Py_UNBLOCK_THREADS |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 115 | |
| 116 | For convenience, that the value of 'errno' is restored across |
Skip Montanaro | 682c25a | 2000-09-15 18:19:27 +0000 | [diff] [blame] | 117 | Py_END_ALLOW_THREADS and Py_BLOCK_THREADS. |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 118 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 119 | WARNING: NEVER NEST CALLS TO Py_BEGIN_ALLOW_THREADS AND |
| 120 | Py_END_ALLOW_THREADS!!! |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 121 | |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 122 | Note that not yet all candidates have been converted to use this |
| 123 | mechanism! |
| 124 | */ |
| 125 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 126 | PyAPI_FUNC(PyThreadState *) PyEval_SaveThread(void); |
| 127 | PyAPI_FUNC(void) PyEval_RestoreThread(PyThreadState *); |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 128 | |
Victor Stinner | b4698ec | 2020-03-10 01:28:54 +0100 | [diff] [blame] | 129 | Py_DEPRECATED(3.9) PyAPI_FUNC(int) PyEval_ThreadsInitialized(void); |
| 130 | Py_DEPRECATED(3.9) PyAPI_FUNC(void) PyEval_InitThreads(void); |
Zackery Spytz | 3c8724f | 2019-05-28 09:16:33 -0600 | [diff] [blame] | 131 | Py_DEPRECATED(3.2) PyAPI_FUNC(void) PyEval_AcquireLock(void); |
| 132 | /* Py_DEPRECATED(3.2) */ PyAPI_FUNC(void) PyEval_ReleaseLock(void); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 133 | PyAPI_FUNC(void) PyEval_AcquireThread(PyThreadState *tstate); |
| 134 | PyAPI_FUNC(void) PyEval_ReleaseThread(PyThreadState *tstate); |
Guido van Rossum | 2fca21f7 | 1997-07-18 23:56:58 +0000 | [diff] [blame] | 135 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 136 | #define Py_BEGIN_ALLOW_THREADS { \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 137 | PyThreadState *_save; \ |
| 138 | _save = PyEval_SaveThread(); |
| 139 | #define Py_BLOCK_THREADS PyEval_RestoreThread(_save); |
| 140 | #define Py_UNBLOCK_THREADS _save = PyEval_SaveThread(); |
| 141 | #define Py_END_ALLOW_THREADS PyEval_RestoreThread(_save); \ |
| 142 | } |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 143 | |
Eric V. Smith | a78c795 | 2015-11-03 12:45:05 -0500 | [diff] [blame] | 144 | /* Masks and values used by FORMAT_VALUE opcode. */ |
| 145 | #define FVC_MASK 0x3 |
| 146 | #define FVC_NONE 0x0 |
| 147 | #define FVC_STR 0x1 |
| 148 | #define FVC_REPR 0x2 |
| 149 | #define FVC_ASCII 0x3 |
| 150 | #define FVS_MASK 0x4 |
| 151 | #define FVS_HAVE_SPEC 0x4 |
Guido van Rossum | 7c36ada | 2000-05-08 14:04:54 +0000 | [diff] [blame] | 152 | |
Victor Stinner | f4b1e3d | 2019-11-04 19:48:34 +0100 | [diff] [blame] | 153 | #ifndef Py_LIMITED_API |
| 154 | # define Py_CPYTHON_CEVAL_H |
| 155 | # include "cpython/ceval.h" |
| 156 | # undef Py_CPYTHON_CEVAL_H |
| 157 | #endif |
| 158 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 159 | #ifdef __cplusplus |
| 160 | } |
| 161 | #endif |
| 162 | #endif /* !Py_CEVAL_H */ |