ceval.h 6.78 KB
Newer Older
1 2 3 4 5 6
#ifndef Py_CEVAL_H
#define Py_CEVAL_H
#ifdef __cplusplus
extern "C" {
#endif

7

Guido van Rossum's avatar
Guido van Rossum committed
8
/* Interface to random parts in ceval.c */
Guido van Rossum's avatar
Guido van Rossum committed
9

10 11
PyAPI_FUNC(PyObject *) PyEval_CallObjectWithKeywords(
	PyObject *, PyObject *, PyObject *);
12

13 14
/* DLL-level Backwards compatibility: */
#undef PyEval_CallObject
15
PyAPI_FUNC(PyObject *) PyEval_CallObject(PyObject *, PyObject *);
16

17 18 19 20
/* Inline this */
#define PyEval_CallObject(func,arg) \
        PyEval_CallObjectWithKeywords(func, arg, (PyObject *)NULL)

21 22
PyAPI_FUNC(PyObject *) PyEval_CallFunction(PyObject *obj,
                                           const char *format, ...);
23
PyAPI_FUNC(PyObject *) PyEval_CallMethod(PyObject *obj,
24 25
                                         const char *methodname,
                                         const char *format, ...);
26

27 28
PyAPI_FUNC(void) PyEval_SetProfile(Py_tracefunc, PyObject *);
PyAPI_FUNC(void) PyEval_SetTrace(Py_tracefunc, PyObject *);
29

30 31
struct _frame; /* Avoid including frameobject.h */

32 33 34
PyAPI_FUNC(PyObject *) PyEval_GetBuiltins(void);
PyAPI_FUNC(PyObject *) PyEval_GetGlobals(void);
PyAPI_FUNC(PyObject *) PyEval_GetLocals(void);
35
PyAPI_FUNC(struct _frame *) PyEval_GetFrame(void);
36 37 38 39

/* Look at the current frame's (if any) code's co_flags, and turn on
   the corresponding compiler flags in cf->cf_flags.  Return 1 if any
   flag was set, else return 0. */
40
PyAPI_FUNC(int) PyEval_MergeCompilerFlags(PyCompilerFlags *cf);
Guido van Rossum's avatar
Guido van Rossum committed
41

42 43
PyAPI_FUNC(int) Py_AddPendingCall(int (*func)(void *), void *arg);
PyAPI_FUNC(int) Py_MakePendingCalls(void);
44

45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
/* Protection against deeply nested recursive calls

   In Python 3.0, this protection has two levels:
   * normal anti-recursion protection is triggered when the recursion level
     exceeds the current recursion limit. It raises a RuntimeError, and sets
     the "overflowed" flag in the thread state structure. This flag
     temporarily *disables* the normal protection; this allows cleanup code
     to potentially outgrow the recursion limit while processing the 
     RuntimeError.
   * "last chance" anti-recursion protection is triggered when the recursion
     level exceeds "current recursion limit + 50". By construction, this
     protection can only be triggered when the "overflowed" flag is set. It
     means the cleanup code has itself gone into an infinite loop, or the
     RuntimeError has been mistakingly ignored. When this protection is
     triggered, the interpreter aborts with a Fatal Error.

   In addition, the "overflowed" flag is automatically reset when the
   recursion level drops below "current recursion limit - 50". This heuristic
   is meant to ensure that the normal anti-recursion protection doesn't get
   disabled too long.

   Please note: this scheme has its own limitations. See:
   http://mail.python.org/pipermail/python-dev/2008-August/082106.html
   for some observations.
*/
70 71
PyAPI_FUNC(void) Py_SetRecursionLimit(int);
PyAPI_FUNC(int) Py_GetRecursionLimit(void);
Guido van Rossum's avatar
Guido van Rossum committed
72

73
#define Py_EnterRecursiveCall(where)  \
74 75 76
	    (_Py_MakeRecCheck(PyThreadState_GET()->recursion_depth) &&  \
	     _Py_CheckRecursiveCall(where))
#define Py_LeaveRecursiveCall()				\
77 78 79
    do{ if(_Py_MakeEndRecCheck(PyThreadState_GET()->recursion_depth))  \
	  PyThreadState_GET()->overflowed = 0;  \
	} while(0)
80 81
PyAPI_FUNC(int) _Py_CheckRecursiveCall(char *where);
PyAPI_DATA(int) _Py_CheckRecursionLimit;
82

83
#ifdef USE_STACKCHECK
84 85 86 87 88 89 90
/* With USE_STACKCHECK, we artificially decrement the recursion limit in order
   to trigger regular stack checks in _Py_CheckRecursiveCall(), except if
   the "overflowed" flag is set, in which case we need the true value
   of _Py_CheckRecursionLimit for _Py_MakeEndRecCheck() to function properly.
*/
#  define _Py_MakeRecCheck(x)  \
	(++(x) > (_Py_CheckRecursionLimit += PyThreadState_GET()->overflowed - 1))
91 92 93 94
#else
#  define _Py_MakeRecCheck(x)  (++(x) > _Py_CheckRecursionLimit)
#endif

95 96 97 98
#define _Py_MakeEndRecCheck(x) \
	(--(x) < ((_Py_CheckRecursionLimit > 100) \
		? (_Py_CheckRecursionLimit - 50) \
		: (3 * (_Py_CheckRecursionLimit >> 2))))
99

100 101 102 103 104 105 106 107
#define Py_ALLOW_RECURSION \
  do { unsigned char _old = PyThreadState_GET()->recursion_critical;\
    PyThreadState_GET()->recursion_critical = 1;

#define Py_END_ALLOW_RECURSION \
    PyThreadState_GET()->recursion_critical = _old; \
  } while(0);

108 109
PyAPI_FUNC(const char *) PyEval_GetFuncName(PyObject *);
PyAPI_FUNC(const char *) PyEval_GetFuncDesc(PyObject *);
110

111
PyAPI_FUNC(PyObject *) PyEval_GetCallStats(PyObject *);
112
PyAPI_FUNC(PyObject *) PyEval_EvalFrame(struct _frame *);
113
PyAPI_FUNC(PyObject *) PyEval_EvalFrameEx(struct _frame *f, int exc);
114

115 116 117 118
/* this used to be handled on a per-thread basis - now just two globals */
PyAPI_DATA(volatile int) _Py_Ticker;
PyAPI_DATA(int) _Py_CheckInterval;

Guido van Rossum's avatar
Guido van Rossum committed
119 120 121 122 123 124 125
/* Interface for threads.

   A module that plans to do a blocking system call (or something else
   that lasts a long time and doesn't touch Python data) can allow other
   threads to run as follows:

	...preparations here...
126
	Py_BEGIN_ALLOW_THREADS
Guido van Rossum's avatar
Guido van Rossum committed
127
	...blocking system call here...
128
	Py_END_ALLOW_THREADS
129
	...interpret result here...
Guido van Rossum's avatar
Guido van Rossum committed
130

131 132
   The Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS pair expands to a
   {}-surrounded block.
Guido van Rossum's avatar
Guido van Rossum committed
133
   To leave the block in the middle (e.g., with return), you must insert
134
   a line containing Py_BLOCK_THREADS before the return, e.g.
Guido van Rossum's avatar
Guido van Rossum committed
135 136

	if (...premature_exit...) {
137 138
		Py_BLOCK_THREADS
		PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum's avatar
Guido van Rossum committed
139 140 141 142 143
		return NULL;
	}

   An alternative is:

144
	Py_BLOCK_THREADS
Guido van Rossum's avatar
Guido van Rossum committed
145
	if (...premature_exit...) {
146
		PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum's avatar
Guido van Rossum committed
147 148
		return NULL;
	}
149
	Py_UNBLOCK_THREADS
Guido van Rossum's avatar
Guido van Rossum committed
150 151

   For convenience, that the value of 'errno' is restored across
152
   Py_END_ALLOW_THREADS and Py_BLOCK_THREADS.
Guido van Rossum's avatar
Guido van Rossum committed
153

154 155
   WARNING: NEVER NEST CALLS TO Py_BEGIN_ALLOW_THREADS AND
   Py_END_ALLOW_THREADS!!!
Guido van Rossum's avatar
Guido van Rossum committed
156

157
   The function PyEval_InitThreads() should be called only from
158
   init_thread() in "_threadmodule.c".
Guido van Rossum's avatar
Guido van Rossum committed
159 160 161 162 163

   Note that not yet all candidates have been converted to use this
   mechanism!
*/

164 165
PyAPI_FUNC(PyThreadState *) PyEval_SaveThread(void);
PyAPI_FUNC(void) PyEval_RestoreThread(PyThreadState *);
Guido van Rossum's avatar
Guido van Rossum committed
166

167
#ifdef WITH_THREAD
Guido van Rossum's avatar
Guido van Rossum committed
168

169
PyAPI_FUNC(int)  PyEval_ThreadsInitialized(void);
170 171 172 173 174 175
PyAPI_FUNC(void) PyEval_InitThreads(void);
PyAPI_FUNC(void) PyEval_AcquireLock(void);
PyAPI_FUNC(void) PyEval_ReleaseLock(void);
PyAPI_FUNC(void) PyEval_AcquireThread(PyThreadState *tstate);
PyAPI_FUNC(void) PyEval_ReleaseThread(PyThreadState *tstate);
PyAPI_FUNC(void) PyEval_ReInitThreads(void);
176

177
#define Py_BEGIN_ALLOW_THREADS { \
178
			PyThreadState *_save; \
179 180 181 182
			_save = PyEval_SaveThread();
#define Py_BLOCK_THREADS	PyEval_RestoreThread(_save);
#define Py_UNBLOCK_THREADS	_save = PyEval_SaveThread();
#define Py_END_ALLOW_THREADS	PyEval_RestoreThread(_save); \
Guido van Rossum's avatar
Guido van Rossum committed
183 184
		 }

185
#else /* !WITH_THREAD */
Guido van Rossum's avatar
Guido van Rossum committed
186

187 188 189 190
#define Py_BEGIN_ALLOW_THREADS {
#define Py_BLOCK_THREADS
#define Py_UNBLOCK_THREADS
#define Py_END_ALLOW_THREADS }
Guido van Rossum's avatar
Guido van Rossum committed
191

192
#endif /* !WITH_THREAD */
193

Martin v. Löwis's avatar
Martin v. Löwis committed
194
PyAPI_FUNC(int) _PyEval_SliceIndex(PyObject *, Py_ssize_t *);
Guido van Rossum's avatar
Guido van Rossum committed
195 196


197 198 199 200
#ifdef __cplusplus
}
#endif
#endif /* !Py_CEVAL_H */