blob: 6b527fbe2144eeb0e5b04af92388b6c55ee53282 [file] [log] [blame]
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001#ifndef Py_INTERNAL_PYSTATE_H
2#define Py_INTERNAL_PYSTATE_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
7#include "pystate.h"
8#include "pyatomic.h"
9#include "pythread.h"
10
11#include "internal/mem.h"
12#include "internal/ceval.h"
13#include "internal/warnings.h"
14
15
16/* GIL state */
17
18struct _gilstate_runtime_state {
19 int check_enabled;
20 /* Assuming the current thread holds the GIL, this is the
21 PyThreadState for the current thread. */
22 _Py_atomic_address tstate_current;
23 PyThreadFrameGetter getframe;
24 /* The single PyInterpreterState used by this process'
25 GILState implementation
26 */
27 /* TODO: Given interp_main, it may be possible to kill this ref */
28 PyInterpreterState *autoInterpreterState;
Masayuki Yamamoto731e1892017-10-06 19:41:34 +090029 Py_tss_t autoTSSkey;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060030};
31
32/* hook for PyEval_GetFrame(), requested for Psyco */
33#define _PyThreadState_GetFrame _PyRuntime.gilstate.getframe
34
35/* Issue #26558: Flag to disable PyGILState_Check().
36 If set to non-zero, PyGILState_Check() always return 1. */
37#define _PyGILState_check_enabled _PyRuntime.gilstate.check_enabled
38
39
Victor Stinnerb64de462017-12-01 18:27:09 +010040typedef struct {
41 /* Full path to the Python program */
42 wchar_t *program_full_path;
43 wchar_t *prefix;
44#ifdef MS_WINDOWS
45 wchar_t *dll_path;
46#else
47 wchar_t *exec_prefix;
48#endif
49 /* Set by Py_SetPath(), or computed by _PyPathConfig_Init() */
50 wchar_t *module_search_path;
Victor Stinner31a83932017-12-04 13:39:15 +010051 /* Python program name */
52 wchar_t *program_name;
53 /* Set by Py_SetPythonHome() or PYTHONHOME environment variable */
54 wchar_t *home;
Victor Stinnerb64de462017-12-01 18:27:09 +010055} _PyPathConfig;
56
Victor Stinner33c377e2017-12-05 15:12:41 +010057#define _PyPathConfig_INIT {.module_search_path = NULL}
58/* Note: _PyPathConfig_INIT sets other fields to 0/NULL */
Victor Stinner31a83932017-12-04 13:39:15 +010059
60PyAPI_DATA(_PyPathConfig) _Py_path_config;
61
62PyAPI_FUNC(_PyInitError) _PyPathConfig_Calculate(
63 _PyPathConfig *config,
64 const _PyMainInterpreterConfig *main_config);
65PyAPI_FUNC(void) _PyPathConfig_Clear(_PyPathConfig *config);
Victor Stinner0ea395a2017-12-01 20:50:58 +010066
Victor Stinnerb64de462017-12-01 18:27:09 +010067
Eric Snow2ebc5ce2017-09-07 23:51:28 -060068/* Full Python runtime state */
69
70typedef struct pyruntimestate {
71 int initialized;
72 int core_initialized;
73 PyThreadState *finalizing;
74
75 struct pyinterpreters {
76 PyThread_type_lock mutex;
77 PyInterpreterState *head;
78 PyInterpreterState *main;
79 /* _next_interp_id is an auto-numbered sequence of small
80 integers. It gets initialized in _PyInterpreterState_Init(),
81 which is called in Py_Initialize(), and used in
82 PyInterpreterState_New(). A negative interpreter ID
83 indicates an error occurred. The main interpreter will
84 always have an ID of 0. Overflow results in a RuntimeError.
85 If that becomes a problem later then we can adjust, e.g. by
86 using a Python int. */
87 int64_t next_id;
88 } interpreters;
89
90#define NEXITFUNCS 32
91 void (*exitfuncs[NEXITFUNCS])(void);
92 int nexitfuncs;
93 void (*pyexitfunc)(void);
94
Eric Snow2ebc5ce2017-09-07 23:51:28 -060095 struct _gc_runtime_state gc;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060096 struct _warnings_runtime_state warnings;
97 struct _ceval_runtime_state ceval;
98 struct _gilstate_runtime_state gilstate;
99
100 // XXX Consolidate globals found via the check-c-globals script.
101} _PyRuntimeState;
102
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800103#define _PyRuntimeState_INIT {.initialized = 0, .core_initialized = 0}
Victor Stinner33c377e2017-12-05 15:12:41 +0100104/* Note: _PyRuntimeState_INIT sets other fields to 0/NULL */
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800105
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600106PyAPI_DATA(_PyRuntimeState) _PyRuntime;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800107PyAPI_FUNC(_PyInitError) _PyRuntimeState_Init(_PyRuntimeState *);
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600108PyAPI_FUNC(void) _PyRuntimeState_Fini(_PyRuntimeState *);
109
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800110/* Initialize _PyRuntimeState.
111 Return NULL on success, or return an error message on failure. */
112PyAPI_FUNC(_PyInitError) _PyRuntime_Initialize(void);
113
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600114#define _Py_CURRENTLY_FINALIZING(tstate) \
115 (_PyRuntime.finalizing == tstate)
116
117
118/* Other */
119
Victor Stinnera7368ac2017-11-15 18:11:45 -0800120PyAPI_FUNC(_PyInitError) _PyInterpreterState_Enable(_PyRuntimeState *);
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600121
122#ifdef __cplusplus
123}
124#endif
125#endif /* !Py_INTERNAL_PYSTATE_H */