blob: f4c9d6eb4b15190d50cd8950044ac6bce2256e53 [file] [log] [blame]
Guido van Rossuma027efa1997-05-05 20:56:21 +00001
2/* Thread and interpreter state structures and their interfaces */
3
4
Fred Drake5eb6d4e2000-07-08 23:37:28 +00005#ifndef Py_PYSTATE_H
6#define Py_PYSTATE_H
7#ifdef __cplusplus
8extern "C" {
9#endif
10
Guido van Rossuma027efa1997-05-05 20:56:21 +000011/* State shared between threads */
12
Guido van Rossum29e46a91997-08-02 02:56:48 +000013struct _ts; /* Forward */
14struct _is; /* Forward */
15
Guido van Rossuma027efa1997-05-05 20:56:21 +000016typedef struct _is {
17
Fred Drake5eb6d4e2000-07-08 23:37:28 +000018 struct _is *next;
19 struct _ts *tstate_head;
Guido van Rossum29e46a91997-08-02 02:56:48 +000020
Fred Drake5eb6d4e2000-07-08 23:37:28 +000021 PyObject *modules;
22 PyObject *sysdict;
23 PyObject *builtins;
Guido van Rossuma027efa1997-05-05 20:56:21 +000024
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +000025 PyObject *codec_search_path;
26 PyObject *codec_search_cache;
27 PyObject *codec_error_registry;
28
Martin v. Löwisf0473d52001-07-18 16:17:16 +000029#ifdef HAVE_DLOPEN
30 int dlopenflags;
31#endif
Guido van Rossuma027efa1997-05-05 20:56:21 +000032
33} PyInterpreterState;
34
35
36/* State unique per thread */
37
38struct _frame; /* Avoid including frameobject.h */
39
Fred Drake55fb6e02001-06-27 19:18:03 +000040/* Py_tracefunc return -1 when raising an exception, or 0 for success. */
41typedef int (*Py_tracefunc)(PyObject *, struct _frame *, int, PyObject *);
42
43/* The following values are used for 'what' for tracefunc functions: */
44#define PyTrace_CALL 0
45#define PyTrace_EXCEPTION 1
46#define PyTrace_LINE 2
47#define PyTrace_RETURN 3
48
Guido van Rossuma027efa1997-05-05 20:56:21 +000049typedef struct _ts {
50
Fred Drake5eb6d4e2000-07-08 23:37:28 +000051 struct _ts *next;
52 PyInterpreterState *interp;
Guido van Rossuma027efa1997-05-05 20:56:21 +000053
Fred Drake5eb6d4e2000-07-08 23:37:28 +000054 struct _frame *frame;
55 int recursion_depth;
Fred Drake5eb6d4e2000-07-08 23:37:28 +000056 int tracing;
Fred Drake9e3ad782001-07-03 23:39:52 +000057 int use_tracing;
Guido van Rossuma027efa1997-05-05 20:56:21 +000058
Fred Drake55fb6e02001-06-27 19:18:03 +000059 Py_tracefunc c_profilefunc;
60 Py_tracefunc c_tracefunc;
61 PyObject *c_profileobj;
62 PyObject *c_traceobj;
Guido van Rossuma027efa1997-05-05 20:56:21 +000063
Fred Drake5eb6d4e2000-07-08 23:37:28 +000064 PyObject *curexc_type;
65 PyObject *curexc_value;
66 PyObject *curexc_traceback;
Guido van Rossuma027efa1997-05-05 20:56:21 +000067
Fred Drake5eb6d4e2000-07-08 23:37:28 +000068 PyObject *exc_type;
69 PyObject *exc_value;
70 PyObject *exc_traceback;
Guido van Rossuma027efa1997-05-05 20:56:21 +000071
Fred Drake5eb6d4e2000-07-08 23:37:28 +000072 PyObject *dict;
Guido van Rossumee0a63b1998-04-13 20:24:05 +000073
Michael W. Hudson019a78e2002-11-08 12:53:11 +000074 int tick_counter;
75
Fred Drake5eb6d4e2000-07-08 23:37:28 +000076 /* XXX signal handlers should also be here */
Guido van Rossuma027efa1997-05-05 20:56:21 +000077
78} PyThreadState;
79
80
Mark Hammond91a681d2002-08-12 07:21:58 +000081PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_New(void);
82PyAPI_FUNC(void) PyInterpreterState_Clear(PyInterpreterState *);
83PyAPI_FUNC(void) PyInterpreterState_Delete(PyInterpreterState *);
Guido van Rossuma027efa1997-05-05 20:56:21 +000084
Mark Hammond91a681d2002-08-12 07:21:58 +000085PyAPI_FUNC(PyThreadState *) PyThreadState_New(PyInterpreterState *);
86PyAPI_FUNC(void) PyThreadState_Clear(PyThreadState *);
87PyAPI_FUNC(void) PyThreadState_Delete(PyThreadState *);
Guido van Rossum29757862001-01-23 01:46:06 +000088#ifdef WITH_THREAD
Mark Hammond91a681d2002-08-12 07:21:58 +000089PyAPI_FUNC(void) PyThreadState_DeleteCurrent(void);
Guido van Rossum29757862001-01-23 01:46:06 +000090#endif
Guido van Rossuma027efa1997-05-05 20:56:21 +000091
Mark Hammond91a681d2002-08-12 07:21:58 +000092PyAPI_FUNC(PyThreadState *) PyThreadState_Get(void);
93PyAPI_FUNC(PyThreadState *) PyThreadState_Swap(PyThreadState *);
94PyAPI_FUNC(PyObject *) PyThreadState_GetDict(void);
Guido van Rossuma027efa1997-05-05 20:56:21 +000095
Guido van Rossum275ea671998-12-21 18:28:10 +000096
97/* Variable and macro for in-line access to current thread state */
98
Mark Hammond91a681d2002-08-12 07:21:58 +000099PyAPI_DATA(PyThreadState *) _PyThreadState_Current;
Guido van Rossum275ea671998-12-21 18:28:10 +0000100
101#ifdef Py_DEBUG
102#define PyThreadState_GET() PyThreadState_Get()
103#else
104#define PyThreadState_GET() (_PyThreadState_Current)
105#endif
106
Guido van Rossumf5df46d2001-07-19 12:19:27 +0000107/* Routines for advanced debuggers, requested by David Beazley.
108 Don't use unless you know what you are doing! */
Mark Hammond91a681d2002-08-12 07:21:58 +0000109PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_Head(void);
110PyAPI_FUNC(PyInterpreterState *) PyInterpreterState_Next(PyInterpreterState *);
111PyAPI_FUNC(PyThreadState *) PyInterpreterState_ThreadHead(PyInterpreterState *);
112PyAPI_FUNC(PyThreadState *) PyThreadState_Next(PyThreadState *);
Guido van Rossumf5df46d2001-07-19 12:19:27 +0000113
Guido van Rossum6297a7a2003-02-19 15:53:17 +0000114typedef struct _frame *(*PyThreadFrameGetter)(PyThreadState *self_);
115
Michael W. Hudson019a78e2002-11-08 12:53:11 +0000116/* hook for PyEval_GetFrame(), requested for Psyco */
Guido van Rossum6297a7a2003-02-19 15:53:17 +0000117PyAPI_DATA(PyThreadFrameGetter) _PyThreadState_GetFrame;
Michael W. Hudson019a78e2002-11-08 12:53:11 +0000118
Guido van Rossuma027efa1997-05-05 20:56:21 +0000119#ifdef __cplusplus
120}
121#endif
122#endif /* !Py_PYSTATE_H */