blob: 09945a8f7a6a07f622f881625c7b02e67511fb7f [file] [log] [blame]
Nick Coghland6009512014-11-20 21:39:37 +10001/* Python interpreter top-level routines, including init/exit */
2
3#include "Python.h"
4
5#include "Python-ast.h"
Victor Stinner3bb183d2018-11-22 18:38:38 +01006#undef Yield /* undefine macro conflicting with <winbase.h> */
Victor Stinner4f98f462020-04-15 04:01:58 +02007
8#include "pycore_ceval.h" // _PyEval_FiniGIL()
9#include "pycore_context.h" // _PyContext_Init()
10#include "pycore_fileutils.h" // _Py_ResetForceASCII()
Victor Stinnere5014be2020-04-14 17:52:15 +020011#include "pycore_import.h" // _PyImport_Cleanup()
Victor Stinner4f98f462020-04-15 04:01:58 +020012#include "pycore_initconfig.h" // _PyStatus_OK()
13#include "pycore_object.h" // _PyDebug_PrintTotalRefs()
14#include "pycore_pathconfig.h" // _PyConfig_WritePathConfig()
15#include "pycore_pyerrors.h" // _PyErr_Occurred()
16#include "pycore_pylifecycle.h" // _PyErr_Print()
Victor Stinnere5014be2020-04-14 17:52:15 +020017#include "pycore_pystate.h" // _PyThreadState_GET()
Victor Stinner4f98f462020-04-15 04:01:58 +020018#include "pycore_sysmodule.h" // _PySys_ClearAuditHooks()
19#include "pycore_traceback.h" // _Py_DumpTracebackThreads()
20
Victor Stinner4f98f462020-04-15 04:01:58 +020021#include <locale.h> // setlocale()
Nick Coghland6009512014-11-20 21:39:37 +100022
23#ifdef HAVE_SIGNAL_H
Victor Stinner4f98f462020-04-15 04:01:58 +020024# include <signal.h> // SIG_IGN
Nick Coghland6009512014-11-20 21:39:37 +100025#endif
26
27#ifdef HAVE_LANGINFO_H
Victor Stinner4f98f462020-04-15 04:01:58 +020028# include <langinfo.h> // nl_langinfo(CODESET)
Nick Coghland6009512014-11-20 21:39:37 +100029#endif
30
31#ifdef MS_WINDOWS
Victor Stinner4f98f462020-04-15 04:01:58 +020032# undef BYTE
33# include "windows.h"
Steve Dower39294992016-08-30 21:22:36 -070034
Victor Stinner4f98f462020-04-15 04:01:58 +020035 extern PyTypeObject PyWindowsConsoleIO_Type;
36# define PyWindowsConsoleIO_Check(op) \
37 (PyObject_TypeCheck((op), &PyWindowsConsoleIO_Type))
Nick Coghland6009512014-11-20 21:39:37 +100038#endif
39
Victor Stinner4f98f462020-04-15 04:01:58 +020040
Nick Coghland6009512014-11-20 21:39:37 +100041_Py_IDENTIFIER(flush);
42_Py_IDENTIFIER(name);
43_Py_IDENTIFIER(stdin);
44_Py_IDENTIFIER(stdout);
45_Py_IDENTIFIER(stderr);
Eric Snow3f9eee62017-09-15 16:35:20 -060046_Py_IDENTIFIER(threading);
Nick Coghland6009512014-11-20 21:39:37 +100047
48#ifdef __cplusplus
49extern "C" {
50#endif
51
Nick Coghland6009512014-11-20 21:39:37 +100052
Victor Stinnerb45d2592019-06-20 00:05:23 +020053/* Forward declarations */
Victor Stinner331a6a52019-05-27 16:39:22 +020054static PyStatus add_main_module(PyInterpreterState *interp);
Victor Stinnerb45d2592019-06-20 00:05:23 +020055static PyStatus init_import_site(void);
Andy Lester75cd5bf2020-03-12 02:49:05 -050056static PyStatus init_set_builtins_open(void);
Victor Stinnerb45d2592019-06-20 00:05:23 +020057static PyStatus init_sys_streams(PyThreadState *tstate);
58static PyStatus init_signals(PyThreadState *tstate);
59static void call_py_exitfuncs(PyThreadState *tstate);
60static void wait_for_thread_shutdown(PyThreadState *tstate);
Victor Stinner8e91c242019-04-24 17:24:01 +020061static void call_ll_exitfuncs(_PyRuntimeState *runtime);
Nick Coghland6009512014-11-20 21:39:37 +100062
Gregory P. Smith38f11cc2019-02-16 12:57:40 -080063int _Py_UnhandledKeyboardInterrupt = 0;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080064_PyRuntimeState _PyRuntime = _PyRuntimeState_INIT;
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010065static int runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060066
Victor Stinner331a6a52019-05-27 16:39:22 +020067PyStatus
Eric Snow2ebc5ce2017-09-07 23:51:28 -060068_PyRuntime_Initialize(void)
69{
70 /* XXX We only initialize once in the process, which aligns with
71 the static initialization of the former globals now found in
72 _PyRuntime. However, _PyRuntime *should* be initialized with
73 every Py_Initialize() call, but doing so breaks the runtime.
74 This is because the runtime state is not properly finalized
75 currently. */
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010076 if (runtime_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +020077 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -080078 }
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010079 runtime_initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080080
81 return _PyRuntimeState_Init(&_PyRuntime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -060082}
83
84void
85_PyRuntime_Finalize(void)
86{
87 _PyRuntimeState_Fini(&_PyRuntime);
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010088 runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060089}
90
91int
92_Py_IsFinalizing(void)
93{
Victor Stinner7b3c2522020-03-07 00:24:23 +010094 return _PyRuntimeState_GetFinalizing(&_PyRuntime) != NULL;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060095}
96
Nick Coghland6009512014-11-20 21:39:37 +100097/* Hack to force loading of object files */
98int (*_PyOS_mystrnicmp_hack)(const char *, const char *, Py_ssize_t) = \
99 PyOS_mystrnicmp; /* Python/pystrcmp.o */
100
101/* PyModule_GetWarningsModule is no longer necessary as of 2.6
102since _warnings is builtin. This API should not be used. */
103PyObject *
104PyModule_GetWarningsModule(void)
105{
106 return PyImport_ImportModule("warnings");
107}
108
Eric Snowc7ec9982017-05-23 23:00:52 -0700109
Eric Snow1abcf672017-05-23 21:46:51 -0700110/* APIs to access the initialization flags
111 *
112 * Can be called prior to Py_Initialize.
113 */
Nick Coghland6009512014-11-20 21:39:37 +1000114
Eric Snow1abcf672017-05-23 21:46:51 -0700115int
116_Py_IsCoreInitialized(void)
117{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600118 return _PyRuntime.core_initialized;
Eric Snow1abcf672017-05-23 21:46:51 -0700119}
Nick Coghland6009512014-11-20 21:39:37 +1000120
121int
122Py_IsInitialized(void)
123{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600124 return _PyRuntime.initialized;
Nick Coghland6009512014-11-20 21:39:37 +1000125}
126
Nick Coghlan6ea41862017-06-11 13:16:15 +1000127
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000128/* Global initializations. Can be undone by Py_FinalizeEx(). Don't
129 call this twice without an intervening Py_FinalizeEx() call. When
Nick Coghland6009512014-11-20 21:39:37 +1000130 initializations fail, a fatal error is issued and the function does
131 not return. On return, the first thread and interpreter state have
132 been created.
133
134 Locking: you must hold the interpreter lock while calling this.
135 (If the lock has not yet been initialized, that's equivalent to
136 having the lock, but you cannot use multiple threads.)
137
138*/
139
Victor Stinner331a6a52019-05-27 16:39:22 +0200140static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200141init_importlib(PyThreadState *tstate, PyObject *sysmod)
Nick Coghland6009512014-11-20 21:39:37 +1000142{
143 PyObject *importlib;
144 PyObject *impmod;
Nick Coghland6009512014-11-20 21:39:37 +1000145 PyObject *value;
Victor Stinnerb45d2592019-06-20 00:05:23 +0200146 PyInterpreterState *interp = tstate->interp;
Victor Stinnerda7933e2020-04-13 03:04:28 +0200147 int verbose = _PyInterpreterState_GetConfig(interp)->verbose;
Nick Coghland6009512014-11-20 21:39:37 +1000148
149 /* Import _importlib through its frozen version, _frozen_importlib. */
150 if (PyImport_ImportFrozenModule("_frozen_importlib") <= 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200151 return _PyStatus_ERR("can't import _frozen_importlib");
Nick Coghland6009512014-11-20 21:39:37 +1000152 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200153 else if (verbose) {
Nick Coghland6009512014-11-20 21:39:37 +1000154 PySys_FormatStderr("import _frozen_importlib # frozen\n");
155 }
156 importlib = PyImport_AddModule("_frozen_importlib");
157 if (importlib == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200158 return _PyStatus_ERR("couldn't get _frozen_importlib from sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000159 }
160 interp->importlib = importlib;
161 Py_INCREF(interp->importlib);
162
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300163 interp->import_func = PyDict_GetItemString(interp->builtins, "__import__");
164 if (interp->import_func == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +0200165 return _PyStatus_ERR("__import__ not found");
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300166 Py_INCREF(interp->import_func);
167
Victor Stinnercd6e6942015-09-18 09:11:57 +0200168 /* Import the _imp module */
Benjamin Petersonc65ef772018-01-29 11:33:57 -0800169 impmod = PyInit__imp();
Nick Coghland6009512014-11-20 21:39:37 +1000170 if (impmod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200171 return _PyStatus_ERR("can't import _imp");
Nick Coghland6009512014-11-20 21:39:37 +1000172 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200173 else if (verbose) {
Victor Stinnercd6e6942015-09-18 09:11:57 +0200174 PySys_FormatStderr("import _imp # builtin\n");
Nick Coghland6009512014-11-20 21:39:37 +1000175 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600176 if (_PyImport_SetModuleString("_imp", impmod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200177 return _PyStatus_ERR("can't save _imp to sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000178 }
179
Victor Stinnercd6e6942015-09-18 09:11:57 +0200180 /* Install importlib as the implementation of import */
Nick Coghland6009512014-11-20 21:39:37 +1000181 value = PyObject_CallMethod(importlib, "_install", "OO", sysmod, impmod);
182 if (value == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200183 _PyErr_Print(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200184 return _PyStatus_ERR("importlib install failed");
Nick Coghland6009512014-11-20 21:39:37 +1000185 }
186 Py_DECREF(value);
187 Py_DECREF(impmod);
188
Victor Stinner331a6a52019-05-27 16:39:22 +0200189 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000190}
191
Victor Stinner331a6a52019-05-27 16:39:22 +0200192static PyStatus
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200193init_importlib_external(PyThreadState *tstate)
Eric Snow1abcf672017-05-23 21:46:51 -0700194{
195 PyObject *value;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200196 value = PyObject_CallMethod(tstate->interp->importlib,
Eric Snow1abcf672017-05-23 21:46:51 -0700197 "_install_external_importers", "");
198 if (value == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200199 _PyErr_Print(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200200 return _PyStatus_ERR("external importer setup failed");
Eric Snow1abcf672017-05-23 21:46:51 -0700201 }
Stéphane Wirtelab1cb802017-06-08 13:13:20 +0200202 Py_DECREF(value);
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200203 return _PyImportZip_Init(tstate);
Eric Snow1abcf672017-05-23 21:46:51 -0700204}
Nick Coghland6009512014-11-20 21:39:37 +1000205
Nick Coghlan6ea41862017-06-11 13:16:15 +1000206/* Helper functions to better handle the legacy C locale
207 *
208 * The legacy C locale assumes ASCII as the default text encoding, which
209 * causes problems not only for the CPython runtime, but also other
210 * components like GNU readline.
211 *
212 * Accordingly, when the CLI detects it, it attempts to coerce it to a
213 * more capable UTF-8 based alternative as follows:
214 *
215 * if (_Py_LegacyLocaleDetected()) {
216 * _Py_CoerceLegacyLocale();
217 * }
218 *
219 * See the documentation of the PYTHONCOERCECLOCALE setting for more details.
220 *
221 * Locale coercion also impacts the default error handler for the standard
222 * streams: while the usual default is "strict", the default for the legacy
223 * C locale and for any of the coercion target locales is "surrogateescape".
224 */
225
226int
Victor Stinner0f721472019-05-20 17:16:38 +0200227_Py_LegacyLocaleDetected(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000228{
229#ifndef MS_WINDOWS
Victor Stinner0f721472019-05-20 17:16:38 +0200230 if (!warn) {
231 const char *locale_override = getenv("LC_ALL");
232 if (locale_override != NULL && *locale_override != '\0') {
233 /* Don't coerce C locale if the LC_ALL environment variable
234 is set */
235 return 0;
236 }
237 }
238
Nick Coghlan6ea41862017-06-11 13:16:15 +1000239 /* On non-Windows systems, the C locale is considered a legacy locale */
Nick Coghlaneb817952017-06-18 12:29:42 +1000240 /* XXX (ncoghlan): some platforms (notably Mac OS X) don't appear to treat
241 * the POSIX locale as a simple alias for the C locale, so
242 * we may also want to check for that explicitly.
243 */
Nick Coghlan6ea41862017-06-11 13:16:15 +1000244 const char *ctype_loc = setlocale(LC_CTYPE, NULL);
245 return ctype_loc != NULL && strcmp(ctype_loc, "C") == 0;
246#else
247 /* Windows uses code pages instead of locales, so no locale is legacy */
248 return 0;
249#endif
250}
251
Victor Stinnerb0051362019-11-22 17:52:42 +0100252#ifndef MS_WINDOWS
Nick Coghlaneb817952017-06-18 12:29:42 +1000253static const char *_C_LOCALE_WARNING =
254 "Python runtime initialized with LC_CTYPE=C (a locale with default ASCII "
255 "encoding), which may cause Unicode compatibility problems. Using C.UTF-8, "
256 "C.utf8, or UTF-8 (if available) as alternative Unicode-compatible "
257 "locales is recommended.\n";
258
Nick Coghlaneb817952017-06-18 12:29:42 +1000259static void
Victor Stinner43125222019-04-24 18:23:53 +0200260emit_stderr_warning_for_legacy_locale(_PyRuntimeState *runtime)
Nick Coghlaneb817952017-06-18 12:29:42 +1000261{
Victor Stinner331a6a52019-05-27 16:39:22 +0200262 const PyPreConfig *preconfig = &runtime->preconfig;
Victor Stinner0f721472019-05-20 17:16:38 +0200263 if (preconfig->coerce_c_locale_warn && _Py_LegacyLocaleDetected(1)) {
Victor Stinnercf215042018-08-29 22:56:06 +0200264 PySys_FormatStderr("%s", _C_LOCALE_WARNING);
Nick Coghlaneb817952017-06-18 12:29:42 +1000265 }
266}
Victor Stinnerb0051362019-11-22 17:52:42 +0100267#endif /* !defined(MS_WINDOWS) */
Nick Coghlaneb817952017-06-18 12:29:42 +1000268
Nick Coghlan6ea41862017-06-11 13:16:15 +1000269typedef struct _CandidateLocale {
270 const char *locale_name; /* The locale to try as a coercion target */
271} _LocaleCoercionTarget;
272
273static _LocaleCoercionTarget _TARGET_LOCALES[] = {
274 {"C.UTF-8"},
275 {"C.utf8"},
Nick Coghlan18974c32017-06-30 00:48:14 +1000276 {"UTF-8"},
Nick Coghlan6ea41862017-06-11 13:16:15 +1000277 {NULL}
278};
279
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200280
281int
282_Py_IsLocaleCoercionTarget(const char *ctype_loc)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000283{
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200284 const _LocaleCoercionTarget *target = NULL;
285 for (target = _TARGET_LOCALES; target->locale_name; target++) {
286 if (strcmp(ctype_loc, target->locale_name) == 0) {
287 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000288 }
Victor Stinner124b9eb2018-08-29 01:29:06 +0200289 }
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200290 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000291}
292
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200293
Nick Coghlan6ea41862017-06-11 13:16:15 +1000294#ifdef PY_COERCE_C_LOCALE
Victor Stinner94540602017-12-16 04:54:22 +0100295static const char C_LOCALE_COERCION_WARNING[] =
Nick Coghlan6ea41862017-06-11 13:16:15 +1000296 "Python detected LC_CTYPE=C: LC_CTYPE coerced to %.20s (set another locale "
297 "or PYTHONCOERCECLOCALE=0 to disable this locale coercion behavior).\n";
298
Victor Stinner0f721472019-05-20 17:16:38 +0200299static int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200300_coerce_default_locale_settings(int warn, const _LocaleCoercionTarget *target)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000301{
302 const char *newloc = target->locale_name;
303
304 /* Reset locale back to currently configured defaults */
xdegaye1588be62017-11-12 12:45:59 +0100305 _Py_SetLocaleFromEnv(LC_ALL);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000306
307 /* Set the relevant locale environment variable */
308 if (setenv("LC_CTYPE", newloc, 1)) {
309 fprintf(stderr,
310 "Error setting LC_CTYPE, skipping C locale coercion\n");
Victor Stinner0f721472019-05-20 17:16:38 +0200311 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000312 }
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200313 if (warn) {
Victor Stinner94540602017-12-16 04:54:22 +0100314 fprintf(stderr, C_LOCALE_COERCION_WARNING, newloc);
Nick Coghlaneb817952017-06-18 12:29:42 +1000315 }
Nick Coghlan6ea41862017-06-11 13:16:15 +1000316
317 /* Reconfigure with the overridden environment variables */
xdegaye1588be62017-11-12 12:45:59 +0100318 _Py_SetLocaleFromEnv(LC_ALL);
Victor Stinner0f721472019-05-20 17:16:38 +0200319 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000320}
321#endif
322
Victor Stinner0f721472019-05-20 17:16:38 +0200323int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200324_Py_CoerceLegacyLocale(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000325{
Victor Stinner0f721472019-05-20 17:16:38 +0200326 int coerced = 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000327#ifdef PY_COERCE_C_LOCALE
Victor Stinner8ea09112018-09-03 17:05:18 +0200328 char *oldloc = NULL;
329
330 oldloc = _PyMem_RawStrdup(setlocale(LC_CTYPE, NULL));
331 if (oldloc == NULL) {
Victor Stinner0f721472019-05-20 17:16:38 +0200332 return coerced;
Victor Stinner8ea09112018-09-03 17:05:18 +0200333 }
334
Victor Stinner94540602017-12-16 04:54:22 +0100335 const char *locale_override = getenv("LC_ALL");
336 if (locale_override == NULL || *locale_override == '\0') {
337 /* LC_ALL is also not set (or is set to an empty string) */
338 const _LocaleCoercionTarget *target = NULL;
339 for (target = _TARGET_LOCALES; target->locale_name; target++) {
340 const char *new_locale = setlocale(LC_CTYPE,
341 target->locale_name);
342 if (new_locale != NULL) {
Victor Stinnere2510952019-05-02 11:28:57 -0400343#if !defined(_Py_FORCE_UTF8_LOCALE) && defined(HAVE_LANGINFO_H) && defined(CODESET)
Victor Stinner94540602017-12-16 04:54:22 +0100344 /* Also ensure that nl_langinfo works in this locale */
345 char *codeset = nl_langinfo(CODESET);
346 if (!codeset || *codeset == '\0') {
347 /* CODESET is not set or empty, so skip coercion */
348 new_locale = NULL;
349 _Py_SetLocaleFromEnv(LC_CTYPE);
350 continue;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000351 }
Victor Stinner94540602017-12-16 04:54:22 +0100352#endif
353 /* Successfully configured locale, so make it the default */
Victor Stinner0f721472019-05-20 17:16:38 +0200354 coerced = _coerce_default_locale_settings(warn, target);
Victor Stinner8ea09112018-09-03 17:05:18 +0200355 goto done;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000356 }
357 }
358 }
359 /* No C locale warning here, as Py_Initialize will emit one later */
Victor Stinner8ea09112018-09-03 17:05:18 +0200360
361 setlocale(LC_CTYPE, oldloc);
362
363done:
364 PyMem_RawFree(oldloc);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000365#endif
Victor Stinner0f721472019-05-20 17:16:38 +0200366 return coerced;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000367}
368
xdegaye1588be62017-11-12 12:45:59 +0100369/* _Py_SetLocaleFromEnv() is a wrapper around setlocale(category, "") to
370 * isolate the idiosyncrasies of different libc implementations. It reads the
371 * appropriate environment variable and uses its value to select the locale for
372 * 'category'. */
373char *
374_Py_SetLocaleFromEnv(int category)
375{
Victor Stinner353933e2018-11-23 13:08:26 +0100376 char *res;
xdegaye1588be62017-11-12 12:45:59 +0100377#ifdef __ANDROID__
378 const char *locale;
379 const char **pvar;
380#ifdef PY_COERCE_C_LOCALE
381 const char *coerce_c_locale;
382#endif
383 const char *utf8_locale = "C.UTF-8";
384 const char *env_var_set[] = {
385 "LC_ALL",
386 "LC_CTYPE",
387 "LANG",
388 NULL,
389 };
390
391 /* Android setlocale(category, "") doesn't check the environment variables
392 * and incorrectly sets the "C" locale at API 24 and older APIs. We only
393 * check the environment variables listed in env_var_set. */
394 for (pvar=env_var_set; *pvar; pvar++) {
395 locale = getenv(*pvar);
396 if (locale != NULL && *locale != '\0') {
397 if (strcmp(locale, utf8_locale) == 0 ||
398 strcmp(locale, "en_US.UTF-8") == 0) {
399 return setlocale(category, utf8_locale);
400 }
401 return setlocale(category, "C");
402 }
403 }
404
405 /* Android uses UTF-8, so explicitly set the locale to C.UTF-8 if none of
406 * LC_ALL, LC_CTYPE, or LANG is set to a non-empty string.
407 * Quote from POSIX section "8.2 Internationalization Variables":
408 * "4. If the LANG environment variable is not set or is set to the empty
409 * string, the implementation-defined default locale shall be used." */
410
411#ifdef PY_COERCE_C_LOCALE
412 coerce_c_locale = getenv("PYTHONCOERCECLOCALE");
413 if (coerce_c_locale == NULL || strcmp(coerce_c_locale, "0") != 0) {
414 /* Some other ported code may check the environment variables (e.g. in
415 * extension modules), so we make sure that they match the locale
416 * configuration */
417 if (setenv("LC_CTYPE", utf8_locale, 1)) {
418 fprintf(stderr, "Warning: failed setting the LC_CTYPE "
419 "environment variable to %s\n", utf8_locale);
420 }
421 }
422#endif
Victor Stinner353933e2018-11-23 13:08:26 +0100423 res = setlocale(category, utf8_locale);
424#else /* !defined(__ANDROID__) */
425 res = setlocale(category, "");
426#endif
427 _Py_ResetForceASCII();
428 return res;
xdegaye1588be62017-11-12 12:45:59 +0100429}
430
Nick Coghlan6ea41862017-06-11 13:16:15 +1000431
Eric Snow1abcf672017-05-23 21:46:51 -0700432/* Global initializations. Can be undone by Py_Finalize(). Don't
433 call this twice without an intervening Py_Finalize() call.
434
Victor Stinner331a6a52019-05-27 16:39:22 +0200435 Every call to Py_InitializeFromConfig, Py_Initialize or Py_InitializeEx
Eric Snow1abcf672017-05-23 21:46:51 -0700436 must have a corresponding call to Py_Finalize.
437
438 Locking: you must hold the interpreter lock while calling these APIs.
439 (If the lock has not yet been initialized, that's equivalent to
440 having the lock, but you cannot use multiple threads.)
441
442*/
443
Victor Stinner331a6a52019-05-27 16:39:22 +0200444static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200445pyinit_core_reconfigure(_PyRuntimeState *runtime,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200446 PyThreadState **tstate_p,
Victor Stinner331a6a52019-05-27 16:39:22 +0200447 const PyConfig *config)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200448{
Victor Stinner331a6a52019-05-27 16:39:22 +0200449 PyStatus status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100450 PyThreadState *tstate = _PyThreadState_GET();
451 if (!tstate) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200452 return _PyStatus_ERR("failed to read thread state");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100453 }
Victor Stinnerb45d2592019-06-20 00:05:23 +0200454 *tstate_p = tstate;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100455
456 PyInterpreterState *interp = tstate->interp;
457 if (interp == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200458 return _PyStatus_ERR("can't make main interpreter");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100459 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100460
Victor Stinnere81f6e62020-06-08 18:12:59 +0200461 status = _PyConfig_Write(config, runtime);
462 if (_PyStatus_EXCEPTION(status)) {
463 return status;
464 }
Victor Stinner1dc6e392018-07-25 02:49:17 +0200465
Victor Stinnerda7933e2020-04-13 03:04:28 +0200466 status = _PyInterpreterState_SetConfig(interp, config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200467 if (_PyStatus_EXCEPTION(status)) {
468 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200469 }
Victor Stinnerda7933e2020-04-13 03:04:28 +0200470 config = _PyInterpreterState_GetConfig(interp);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200471
Victor Stinner331a6a52019-05-27 16:39:22 +0200472 if (config->_install_importlib) {
Victor Stinner12f2f172019-09-26 15:51:50 +0200473 status = _PyConfig_WritePathConfig(config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200474 if (_PyStatus_EXCEPTION(status)) {
475 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200476 }
477 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200478 return _PyStatus_OK();
Victor Stinner1dc6e392018-07-25 02:49:17 +0200479}
480
481
Victor Stinner331a6a52019-05-27 16:39:22 +0200482static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200483pycore_init_runtime(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200484 const PyConfig *config)
Nick Coghland6009512014-11-20 21:39:37 +1000485{
Victor Stinner43125222019-04-24 18:23:53 +0200486 if (runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200487 return _PyStatus_ERR("main interpreter already initialized");
Victor Stinner1dc6e392018-07-25 02:49:17 +0200488 }
Victor Stinnerda273412017-12-15 01:46:02 +0100489
Victor Stinnere81f6e62020-06-08 18:12:59 +0200490 PyStatus status = _PyConfig_Write(config, runtime);
491 if (_PyStatus_EXCEPTION(status)) {
492 return status;
493 }
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600494
Eric Snow1abcf672017-05-23 21:46:51 -0700495 /* Py_Finalize leaves _Py_Finalizing set in order to help daemon
496 * threads behave a little more gracefully at interpreter shutdown.
497 * We clobber it here so the new interpreter can start with a clean
498 * slate.
499 *
500 * However, this may still lead to misbehaviour if there are daemon
501 * threads still hanging around from a previous Py_Initialize/Finalize
502 * pair :(
503 */
Victor Stinner7b3c2522020-03-07 00:24:23 +0100504 _PyRuntimeState_SetFinalizing(runtime, NULL);
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600505
Victor Stinnere81f6e62020-06-08 18:12:59 +0200506 status = _Py_HashRandomization_Init(config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200507 if (_PyStatus_EXCEPTION(status)) {
508 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800509 }
510
Victor Stinner331a6a52019-05-27 16:39:22 +0200511 status = _PyInterpreterState_Enable(runtime);
512 if (_PyStatus_EXCEPTION(status)) {
513 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -0800514 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200515 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100516}
Victor Stinnera7368ac2017-11-15 18:11:45 -0800517
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100518
Victor Stinner331a6a52019-05-27 16:39:22 +0200519static PyStatus
Victor Stinnerdda5d6e2020-04-08 17:54:59 +0200520init_interp_create_gil(PyThreadState *tstate)
521{
522 PyStatus status;
523
524 /* finalize_interp_delete() comment explains why _PyEval_FiniGIL() is
525 only called here. */
526 _PyEval_FiniGIL(tstate);
527
528 /* Auto-thread-state API */
529 status = _PyGILState_Init(tstate);
530 if (_PyStatus_EXCEPTION(status)) {
531 return status;
532 }
533
534 /* Create the GIL and take it */
535 status = _PyEval_InitGIL(tstate);
536 if (_PyStatus_EXCEPTION(status)) {
537 return status;
538 }
539
540 return _PyStatus_OK();
541}
542
543
544static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200545pycore_create_interpreter(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200546 const PyConfig *config,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200547 PyThreadState **tstate_p)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100548{
549 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnerda273412017-12-15 01:46:02 +0100550 if (interp == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200551 return _PyStatus_ERR("can't make main interpreter");
Victor Stinnerda273412017-12-15 01:46:02 +0100552 }
553
Victor Stinnerda7933e2020-04-13 03:04:28 +0200554 PyStatus status = _PyInterpreterState_SetConfig(interp, config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200555 if (_PyStatus_EXCEPTION(status)) {
556 return status;
Victor Stinnerda273412017-12-15 01:46:02 +0100557 }
Nick Coghland6009512014-11-20 21:39:37 +1000558
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200559 PyThreadState *tstate = PyThreadState_New(interp);
Victor Stinnerb45d2592019-06-20 00:05:23 +0200560 if (tstate == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200561 return _PyStatus_ERR("can't make first thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +0200562 }
Nick Coghland6009512014-11-20 21:39:37 +1000563 (void) PyThreadState_Swap(tstate);
564
Victor Stinnerdda5d6e2020-04-08 17:54:59 +0200565 status = init_interp_create_gil(tstate);
Victor Stinner111e4ee2020-03-09 21:24:14 +0100566 if (_PyStatus_EXCEPTION(status)) {
567 return status;
568 }
Victor Stinner2914bb32018-01-29 11:57:45 +0100569
Victor Stinnerb45d2592019-06-20 00:05:23 +0200570 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +0200571 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100572}
Nick Coghland6009512014-11-20 21:39:37 +1000573
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100574
Victor Stinner331a6a52019-05-27 16:39:22 +0200575static PyStatus
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100576pycore_init_types(PyThreadState *tstate)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100577{
Victor Stinner444b39b2019-11-20 01:18:11 +0100578 PyStatus status;
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100579 int is_main_interp = _Py_IsMainInterpreter(tstate);
Victor Stinner444b39b2019-11-20 01:18:11 +0100580
Victor Stinner01b1cc12019-11-20 02:27:56 +0100581 status = _PyGC_Init(tstate);
Victor Stinner444b39b2019-11-20 01:18:11 +0100582 if (_PyStatus_EXCEPTION(status)) {
583 return status;
584 }
585
Victor Stinnere7e699e2019-11-20 12:08:13 +0100586 if (is_main_interp) {
587 status = _PyTypes_Init();
588 if (_PyStatus_EXCEPTION(status)) {
589 return status;
590 }
Victor Stinner630c8df2019-12-17 13:02:18 +0100591 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100592
Victor Stinner630c8df2019-12-17 13:02:18 +0100593
594 if (!_PyLong_Init(tstate)) {
595 return _PyStatus_ERR("can't init longs");
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100596 }
Victor Stinneref5aa9a2019-11-20 00:38:03 +0100597
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100598 if (is_main_interp) {
Victor Stinnere7e699e2019-11-20 12:08:13 +0100599 status = _PyUnicode_Init();
600 if (_PyStatus_EXCEPTION(status)) {
601 return status;
602 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100603 }
604
Victor Stinner331a6a52019-05-27 16:39:22 +0200605 status = _PyExc_Init();
606 if (_PyStatus_EXCEPTION(status)) {
607 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100608 }
609
Victor Stinnere7e699e2019-11-20 12:08:13 +0100610 if (is_main_interp) {
611 if (!_PyFloat_Init()) {
612 return _PyStatus_ERR("can't init float");
613 }
Nick Coghland6009512014-11-20 21:39:37 +1000614
Victor Stinnere7e699e2019-11-20 12:08:13 +0100615 if (_PyStructSequence_Init() < 0) {
616 return _PyStatus_ERR("can't initialize structseq");
617 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100618 }
Victor Stinneref9d9b62019-05-22 11:28:22 +0200619
Victor Stinner331a6a52019-05-27 16:39:22 +0200620 status = _PyErr_Init();
621 if (_PyStatus_EXCEPTION(status)) {
622 return status;
Victor Stinneref9d9b62019-05-22 11:28:22 +0200623 }
624
Victor Stinnere7e699e2019-11-20 12:08:13 +0100625 if (is_main_interp) {
626 if (!_PyContext_Init()) {
627 return _PyStatus_ERR("can't init context");
628 }
Victor Stinneref5aa9a2019-11-20 00:38:03 +0100629 }
630
Victor Stinner331a6a52019-05-27 16:39:22 +0200631 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100632}
633
634
Victor Stinner331a6a52019-05-27 16:39:22 +0200635static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200636pycore_init_builtins(PyThreadState *tstate)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100637{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100638 assert(!_PyErr_Occurred(tstate));
639
Victor Stinnerb45d2592019-06-20 00:05:23 +0200640 PyObject *bimod = _PyBuiltin_Init(tstate);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100641 if (bimod == NULL) {
Victor Stinner2582d462019-11-22 19:24:49 +0100642 goto error;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100643 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100644
Victor Stinner2582d462019-11-22 19:24:49 +0100645 PyInterpreterState *interp = tstate->interp;
646 if (_PyImport_FixupBuiltin(bimod, "builtins", interp->modules) < 0) {
647 goto error;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100648 }
Victor Stinner2582d462019-11-22 19:24:49 +0100649
650 PyObject *builtins_dict = PyModule_GetDict(bimod);
651 if (builtins_dict == NULL) {
652 goto error;
653 }
654 Py_INCREF(builtins_dict);
655 interp->builtins = builtins_dict;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100656
Victor Stinner331a6a52019-05-27 16:39:22 +0200657 PyStatus status = _PyBuiltins_AddExceptions(bimod);
658 if (_PyStatus_EXCEPTION(status)) {
659 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100660 }
Victor Stinner2582d462019-11-22 19:24:49 +0100661
662 interp->builtins_copy = PyDict_Copy(interp->builtins);
663 if (interp->builtins_copy == NULL) {
664 goto error;
665 }
Pablo Galindob96c6b02019-12-04 11:19:59 +0000666 Py_DECREF(bimod);
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100667
668 assert(!_PyErr_Occurred(tstate));
669
Victor Stinner331a6a52019-05-27 16:39:22 +0200670 return _PyStatus_OK();
Victor Stinner2582d462019-11-22 19:24:49 +0100671
672error:
Pablo Galindob96c6b02019-12-04 11:19:59 +0000673 Py_XDECREF(bimod);
Victor Stinner2582d462019-11-22 19:24:49 +0100674 return _PyStatus_ERR("can't initialize builtins module");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100675}
676
677
Victor Stinner331a6a52019-05-27 16:39:22 +0200678static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200679pycore_init_import_warnings(PyThreadState *tstate, PyObject *sysmod)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100680{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100681 assert(!_PyErr_Occurred(tstate));
Victor Stinnerb45d2592019-06-20 00:05:23 +0200682
Victor Stinner2582d462019-11-22 19:24:49 +0100683 PyStatus status = _PyImportHooks_Init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200684 if (_PyStatus_EXCEPTION(status)) {
685 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800686 }
Nick Coghland6009512014-11-20 21:39:37 +1000687
Victor Stinner30a89332020-06-23 15:55:45 +0200688 /* Initialize _warnings. */
689 status = _PyWarnings_InitState(tstate);
690 if (_PyStatus_EXCEPTION(status)) {
691 return status;
692 }
Nick Coghland6009512014-11-20 21:39:37 +1000693
Victor Stinner30a89332020-06-23 15:55:45 +0200694 const PyConfig *config = _PyInterpreterState_GetConfig(tstate->interp);
695 if (config->_install_importlib) {
696 if (_Py_IsMainInterpreter(tstate)) {
Victor Stinner2ec1a1b2019-11-22 21:54:33 +0100697 status = _PyConfig_WritePathConfig(config);
698 if (_PyStatus_EXCEPTION(status)) {
699 return status;
700 }
Victor Stinnerb1147e42018-07-21 02:06:16 +0200701 }
Victor Stinnerb1147e42018-07-21 02:06:16 +0200702
Victor Stinner30a89332020-06-23 15:55:45 +0200703 /* This call sets up builtin and frozen import support */
Victor Stinnerb45d2592019-06-20 00:05:23 +0200704 status = init_importlib(tstate, sysmod);
Victor Stinner331a6a52019-05-27 16:39:22 +0200705 if (_PyStatus_EXCEPTION(status)) {
706 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800707 }
Eric Snow1abcf672017-05-23 21:46:51 -0700708 }
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100709
710 assert(!_PyErr_Occurred(tstate));
711
Victor Stinner331a6a52019-05-27 16:39:22 +0200712 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100713}
714
715
Victor Stinner331a6a52019-05-27 16:39:22 +0200716static PyStatus
Victor Stinnerd863ade2019-12-06 03:37:07 +0100717pycore_interp_init(PyThreadState *tstate)
718{
719 PyStatus status;
Victor Stinner080ee5a2019-12-08 21:55:58 +0100720 PyObject *sysmod = NULL;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100721
722 status = pycore_init_types(tstate);
723 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100724 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100725 }
726
Victor Stinnerd863ade2019-12-06 03:37:07 +0100727 status = _PySys_Create(tstate, &sysmod);
728 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100729 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100730 }
731
732 status = pycore_init_builtins(tstate);
733 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100734 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100735 }
736
Victor Stinner080ee5a2019-12-08 21:55:58 +0100737 status = pycore_init_import_warnings(tstate, sysmod);
738
739done:
740 /* sys.modules['sys'] contains a strong reference to the module */
741 Py_XDECREF(sysmod);
742 return status;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100743}
744
745
746static PyStatus
Victor Stinner331a6a52019-05-27 16:39:22 +0200747pyinit_config(_PyRuntimeState *runtime,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200748 PyThreadState **tstate_p,
Victor Stinner331a6a52019-05-27 16:39:22 +0200749 const PyConfig *config)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100750{
Victor Stinner331a6a52019-05-27 16:39:22 +0200751 PyStatus status = pycore_init_runtime(runtime, config);
752 if (_PyStatus_EXCEPTION(status)) {
753 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100754 }
755
Victor Stinnerb45d2592019-06-20 00:05:23 +0200756 PyThreadState *tstate;
757 status = pycore_create_interpreter(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200758 if (_PyStatus_EXCEPTION(status)) {
759 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100760 }
Victor Stinnerb45d2592019-06-20 00:05:23 +0200761 *tstate_p = tstate;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100762
Victor Stinnerd863ade2019-12-06 03:37:07 +0100763 status = pycore_interp_init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200764 if (_PyStatus_EXCEPTION(status)) {
765 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100766 }
Eric Snow1abcf672017-05-23 21:46:51 -0700767
768 /* Only when we get here is the runtime core fully initialized */
Victor Stinner43125222019-04-24 18:23:53 +0200769 runtime->core_initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200770 return _PyStatus_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700771}
772
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100773
Victor Stinner331a6a52019-05-27 16:39:22 +0200774PyStatus
775_Py_PreInitializeFromPyArgv(const PyPreConfig *src_config, const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100776{
Victor Stinner331a6a52019-05-27 16:39:22 +0200777 PyStatus status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100778
Victor Stinner6d1c4672019-05-20 11:02:00 +0200779 if (src_config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200780 return _PyStatus_ERR("preinitialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +0200781 }
782
Victor Stinner331a6a52019-05-27 16:39:22 +0200783 status = _PyRuntime_Initialize();
784 if (_PyStatus_EXCEPTION(status)) {
785 return status;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100786 }
Victor Stinner43125222019-04-24 18:23:53 +0200787 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100788
Victor Stinnerd3b90412019-09-17 23:59:51 +0200789 if (runtime->preinitialized) {
Victor Stinnerf72346c2019-03-25 17:54:58 +0100790 /* If it's already configured: ignored the new configuration */
Victor Stinner331a6a52019-05-27 16:39:22 +0200791 return _PyStatus_OK();
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100792 }
793
Victor Stinnerd3b90412019-09-17 23:59:51 +0200794 /* Note: preinitialized remains 1 on error, it is only set to 0
795 at exit on success. */
796 runtime->preinitializing = 1;
797
Victor Stinner331a6a52019-05-27 16:39:22 +0200798 PyPreConfig config;
Victor Stinner441b10c2019-09-28 04:28:35 +0200799
800 status = _PyPreConfig_InitFromPreConfig(&config, src_config);
801 if (_PyStatus_EXCEPTION(status)) {
802 return status;
803 }
Victor Stinnerf72346c2019-03-25 17:54:58 +0100804
Victor Stinner331a6a52019-05-27 16:39:22 +0200805 status = _PyPreConfig_Read(&config, args);
806 if (_PyStatus_EXCEPTION(status)) {
807 return status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100808 }
809
Victor Stinner331a6a52019-05-27 16:39:22 +0200810 status = _PyPreConfig_Write(&config);
811 if (_PyStatus_EXCEPTION(status)) {
812 return status;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100813 }
814
Victor Stinnerd3b90412019-09-17 23:59:51 +0200815 runtime->preinitializing = 0;
816 runtime->preinitialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200817 return _PyStatus_OK();
Victor Stinnerf72346c2019-03-25 17:54:58 +0100818}
819
Victor Stinner70005ac2019-05-02 15:25:34 -0400820
Victor Stinner331a6a52019-05-27 16:39:22 +0200821PyStatus
822Py_PreInitializeFromBytesArgs(const PyPreConfig *src_config, Py_ssize_t argc, char **argv)
Victor Stinnerf72346c2019-03-25 17:54:58 +0100823{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100824 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400825 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100826}
827
828
Victor Stinner331a6a52019-05-27 16:39:22 +0200829PyStatus
830Py_PreInitializeFromArgs(const PyPreConfig *src_config, Py_ssize_t argc, wchar_t **argv)
Victor Stinner20004952019-03-26 02:31:11 +0100831{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100832 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400833 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinner20004952019-03-26 02:31:11 +0100834}
835
836
Victor Stinner331a6a52019-05-27 16:39:22 +0200837PyStatus
838Py_PreInitialize(const PyPreConfig *src_config)
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100839{
Victor Stinner70005ac2019-05-02 15:25:34 -0400840 return _Py_PreInitializeFromPyArgv(src_config, NULL);
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100841}
842
843
Victor Stinner331a6a52019-05-27 16:39:22 +0200844PyStatus
845_Py_PreInitializeFromConfig(const PyConfig *config,
846 const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100847{
Victor Stinner331a6a52019-05-27 16:39:22 +0200848 assert(config != NULL);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200849
Victor Stinner331a6a52019-05-27 16:39:22 +0200850 PyStatus status = _PyRuntime_Initialize();
851 if (_PyStatus_EXCEPTION(status)) {
852 return status;
Victor Stinner6d1c4672019-05-20 11:02:00 +0200853 }
854 _PyRuntimeState *runtime = &_PyRuntime;
855
Victor Stinnerd3b90412019-09-17 23:59:51 +0200856 if (runtime->preinitialized) {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200857 /* Already initialized: do nothing */
Victor Stinner331a6a52019-05-27 16:39:22 +0200858 return _PyStatus_OK();
Victor Stinner70005ac2019-05-02 15:25:34 -0400859 }
Victor Stinnercab5d072019-05-17 19:01:14 +0200860
Victor Stinner331a6a52019-05-27 16:39:22 +0200861 PyPreConfig preconfig;
Victor Stinner441b10c2019-09-28 04:28:35 +0200862
Victor Stinner3c30a762019-10-01 10:56:37 +0200863 _PyPreConfig_InitFromConfig(&preconfig, config);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200864
Victor Stinner331a6a52019-05-27 16:39:22 +0200865 if (!config->parse_argv) {
866 return Py_PreInitialize(&preconfig);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200867 }
868 else if (args == NULL) {
Victor Stinnercab5d072019-05-17 19:01:14 +0200869 _PyArgv config_args = {
870 .use_bytes_argv = 0,
Victor Stinner331a6a52019-05-27 16:39:22 +0200871 .argc = config->argv.length,
872 .wchar_argv = config->argv.items};
Victor Stinner6d1c4672019-05-20 11:02:00 +0200873 return _Py_PreInitializeFromPyArgv(&preconfig, &config_args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200874 }
875 else {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200876 return _Py_PreInitializeFromPyArgv(&preconfig, args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200877 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100878}
879
880
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100881/* Begin interpreter initialization
882 *
883 * On return, the first thread and interpreter state have been created,
884 * but the compiler, signal handling, multithreading and
885 * multiple interpreter support, and codec infrastructure are not yet
886 * available.
887 *
888 * The import system will support builtin and frozen modules only.
889 * The only supported io is writing to sys.stderr
890 *
891 * If any operation invoked by this function fails, a fatal error is
892 * issued and the function does not return.
893 *
894 * Any code invoked from this function should *not* assume it has access
895 * to the Python C API (unless the API is explicitly listed as being
896 * safe to call without calling Py_Initialize first)
897 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200898static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200899pyinit_core(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200900 const PyConfig *src_config,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200901 PyThreadState **tstate_p)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200902{
Victor Stinner331a6a52019-05-27 16:39:22 +0200903 PyStatus status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200904
Victor Stinner331a6a52019-05-27 16:39:22 +0200905 status = _Py_PreInitializeFromConfig(src_config, NULL);
906 if (_PyStatus_EXCEPTION(status)) {
907 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200908 }
909
Victor Stinner331a6a52019-05-27 16:39:22 +0200910 PyConfig config;
Victor Stinner8462a492019-10-01 12:06:16 +0200911 _PyConfig_InitCompatConfig(&config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200912
Victor Stinner331a6a52019-05-27 16:39:22 +0200913 status = _PyConfig_Copy(&config, src_config);
914 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200915 goto done;
916 }
917
Victor Stinner331a6a52019-05-27 16:39:22 +0200918 status = PyConfig_Read(&config);
919 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200920 goto done;
921 }
922
923 if (!runtime->core_initialized) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200924 status = pyinit_config(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200925 }
926 else {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200927 status = pyinit_core_reconfigure(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200928 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200929 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200930 goto done;
931 }
932
933done:
Victor Stinner331a6a52019-05-27 16:39:22 +0200934 PyConfig_Clear(&config);
935 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200936}
937
Victor Stinner5ac27a52019-03-27 13:40:14 +0100938
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200939/* Py_Initialize() has already been called: update the main interpreter
940 configuration. Example of bpo-34008: Py_Main() called after
941 Py_Initialize(). */
Victor Stinner331a6a52019-05-27 16:39:22 +0200942static PyStatus
Victor Stinnerb0051362019-11-22 17:52:42 +0100943_Py_ReconfigureMainInterpreter(PyThreadState *tstate)
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200944{
Victor Stinnerda7933e2020-04-13 03:04:28 +0200945 const PyConfig *config = _PyInterpreterState_GetConfig(tstate->interp);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100946
Victor Stinner331a6a52019-05-27 16:39:22 +0200947 PyObject *argv = _PyWideStringList_AsList(&config->argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100948 if (argv == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200949 return _PyStatus_NO_MEMORY(); \
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100950 }
951
Victor Stinnerb0051362019-11-22 17:52:42 +0100952 int res = PyDict_SetItemString(tstate->interp->sysdict, "argv", argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100953 Py_DECREF(argv);
954 if (res < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200955 return _PyStatus_ERR("fail to set sys.argv");
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200956 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200957 return _PyStatus_OK();
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200958}
959
Victor Stinnerb0051362019-11-22 17:52:42 +0100960
961static PyStatus
962init_interp_main(PyThreadState *tstate)
963{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100964 assert(!_PyErr_Occurred(tstate));
965
Victor Stinnerb0051362019-11-22 17:52:42 +0100966 PyStatus status;
967 int is_main_interp = _Py_IsMainInterpreter(tstate);
968 PyInterpreterState *interp = tstate->interp;
Victor Stinnerda7933e2020-04-13 03:04:28 +0200969 const PyConfig *config = _PyInterpreterState_GetConfig(interp);
Victor Stinnerb0051362019-11-22 17:52:42 +0100970
971 if (!config->_install_importlib) {
972 /* Special mode for freeze_importlib: run with no import system
973 *
974 * This means anything which needs support from extension modules
975 * or pure Python code in the standard library won't work.
976 */
977 if (is_main_interp) {
978 interp->runtime->initialized = 1;
979 }
980 return _PyStatus_OK();
981 }
982
983 if (is_main_interp) {
984 if (_PyTime_Init() < 0) {
985 return _PyStatus_ERR("can't initialize time");
986 }
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100987 }
Victor Stinnerb0051362019-11-22 17:52:42 +0100988
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100989 if (_PySys_InitMain(tstate) < 0) {
990 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerb0051362019-11-22 17:52:42 +0100991 }
992
993 status = init_importlib_external(tstate);
994 if (_PyStatus_EXCEPTION(status)) {
995 return status;
996 }
997
998 if (is_main_interp) {
999 /* initialize the faulthandler module */
1000 status = _PyFaulthandler_Init(config->faulthandler);
1001 if (_PyStatus_EXCEPTION(status)) {
1002 return status;
1003 }
1004 }
1005
1006 status = _PyUnicode_InitEncodings(tstate);
1007 if (_PyStatus_EXCEPTION(status)) {
1008 return status;
1009 }
1010
1011 if (is_main_interp) {
1012 if (config->install_signal_handlers) {
1013 status = init_signals(tstate);
1014 if (_PyStatus_EXCEPTION(status)) {
1015 return status;
1016 }
1017 }
1018
1019 if (_PyTraceMalloc_Init(config->tracemalloc) < 0) {
1020 return _PyStatus_ERR("can't initialize tracemalloc");
1021 }
1022 }
1023
1024 status = init_sys_streams(tstate);
1025 if (_PyStatus_EXCEPTION(status)) {
1026 return status;
1027 }
1028
Andy Lester75cd5bf2020-03-12 02:49:05 -05001029 status = init_set_builtins_open();
Victor Stinnerb0051362019-11-22 17:52:42 +01001030 if (_PyStatus_EXCEPTION(status)) {
1031 return status;
1032 }
1033
1034 status = add_main_module(interp);
1035 if (_PyStatus_EXCEPTION(status)) {
1036 return status;
1037 }
1038
1039 if (is_main_interp) {
1040 /* Initialize warnings. */
1041 PyObject *warnoptions = PySys_GetObject("warnoptions");
1042 if (warnoptions != NULL && PyList_Size(warnoptions) > 0)
1043 {
1044 PyObject *warnings_module = PyImport_ImportModule("warnings");
1045 if (warnings_module == NULL) {
1046 fprintf(stderr, "'import warnings' failed; traceback:\n");
1047 _PyErr_Print(tstate);
1048 }
1049 Py_XDECREF(warnings_module);
1050 }
1051
1052 interp->runtime->initialized = 1;
1053 }
1054
1055 if (config->site_import) {
1056 status = init_import_site();
1057 if (_PyStatus_EXCEPTION(status)) {
1058 return status;
1059 }
1060 }
1061
1062 if (is_main_interp) {
1063#ifndef MS_WINDOWS
1064 emit_stderr_warning_for_legacy_locale(interp->runtime);
1065#endif
1066 }
1067
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001068 assert(!_PyErr_Occurred(tstate));
1069
Victor Stinnerb0051362019-11-22 17:52:42 +01001070 return _PyStatus_OK();
1071}
1072
1073
Eric Snowc7ec9982017-05-23 23:00:52 -07001074/* Update interpreter state based on supplied configuration settings
1075 *
1076 * After calling this function, most of the restrictions on the interpreter
1077 * are lifted. The only remaining incomplete settings are those related
1078 * to the main module (sys.argv[0], __main__ metadata)
1079 *
1080 * Calling this when the interpreter is not initializing, is already
1081 * initialized or without a valid current thread state is a fatal error.
1082 * Other errors should be reported as normal Python exceptions with a
1083 * non-zero return code.
1084 */
Victor Stinner331a6a52019-05-27 16:39:22 +02001085static PyStatus
Victor Stinner01b1cc12019-11-20 02:27:56 +01001086pyinit_main(PyThreadState *tstate)
Eric Snow1abcf672017-05-23 21:46:51 -07001087{
Victor Stinnerb0051362019-11-22 17:52:42 +01001088 PyInterpreterState *interp = tstate->interp;
1089 if (!interp->runtime->core_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001090 return _PyStatus_ERR("runtime core not initialized");
Eric Snowc7ec9982017-05-23 23:00:52 -07001091 }
Eric Snowc7ec9982017-05-23 23:00:52 -07001092
Victor Stinnerb0051362019-11-22 17:52:42 +01001093 if (interp->runtime->initialized) {
1094 return _Py_ReconfigureMainInterpreter(tstate);
Victor Stinnerfb47bca2018-07-20 17:34:23 +02001095 }
1096
Victor Stinnerb0051362019-11-22 17:52:42 +01001097 PyStatus status = init_interp_main(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001098 if (_PyStatus_EXCEPTION(status)) {
1099 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001100 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001101 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001102}
1103
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001104
Victor Stinner331a6a52019-05-27 16:39:22 +02001105PyStatus
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001106_Py_InitializeMain(void)
1107{
Victor Stinner331a6a52019-05-27 16:39:22 +02001108 PyStatus status = _PyRuntime_Initialize();
1109 if (_PyStatus_EXCEPTION(status)) {
1110 return status;
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001111 }
1112 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinnerb45d2592019-06-20 00:05:23 +02001113 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
Victor Stinner01b1cc12019-11-20 02:27:56 +01001114 return pyinit_main(tstate);
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001115}
1116
1117
Victor Stinner331a6a52019-05-27 16:39:22 +02001118PyStatus
1119Py_InitializeFromConfig(const PyConfig *config)
Eric Snow1abcf672017-05-23 21:46:51 -07001120{
Victor Stinner6d1c4672019-05-20 11:02:00 +02001121 if (config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001122 return _PyStatus_ERR("initialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +02001123 }
1124
Victor Stinner331a6a52019-05-27 16:39:22 +02001125 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001126
Victor Stinner331a6a52019-05-27 16:39:22 +02001127 status = _PyRuntime_Initialize();
1128 if (_PyStatus_EXCEPTION(status)) {
1129 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001130 }
1131 _PyRuntimeState *runtime = &_PyRuntime;
1132
Victor Stinnerb45d2592019-06-20 00:05:23 +02001133 PyThreadState *tstate = NULL;
1134 status = pyinit_core(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001135 if (_PyStatus_EXCEPTION(status)) {
1136 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001137 }
Victor Stinnerda7933e2020-04-13 03:04:28 +02001138 config = _PyInterpreterState_GetConfig(tstate->interp);
Victor Stinnerbc8ac6b2017-11-30 18:03:55 +01001139
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001140 if (config->_init_main) {
Victor Stinner01b1cc12019-11-20 02:27:56 +01001141 status = pyinit_main(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001142 if (_PyStatus_EXCEPTION(status)) {
1143 return status;
Victor Stinner484f20d2019-03-27 02:04:16 +01001144 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001145 }
Victor Stinner484f20d2019-03-27 02:04:16 +01001146
Victor Stinner331a6a52019-05-27 16:39:22 +02001147 return _PyStatus_OK();
Victor Stinner5ac27a52019-03-27 13:40:14 +01001148}
1149
1150
Eric Snow1abcf672017-05-23 21:46:51 -07001151void
Nick Coghland6009512014-11-20 21:39:37 +10001152Py_InitializeEx(int install_sigs)
1153{
Victor Stinner331a6a52019-05-27 16:39:22 +02001154 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001155
Victor Stinner331a6a52019-05-27 16:39:22 +02001156 status = _PyRuntime_Initialize();
1157 if (_PyStatus_EXCEPTION(status)) {
1158 Py_ExitStatusException(status);
Victor Stinner43125222019-04-24 18:23:53 +02001159 }
1160 _PyRuntimeState *runtime = &_PyRuntime;
1161
1162 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001163 /* bpo-33932: Calling Py_Initialize() twice does nothing. */
1164 return;
1165 }
1166
Victor Stinner331a6a52019-05-27 16:39:22 +02001167 PyConfig config;
Victor Stinner8462a492019-10-01 12:06:16 +02001168 _PyConfig_InitCompatConfig(&config);
Victor Stinner441b10c2019-09-28 04:28:35 +02001169
Victor Stinner1dc6e392018-07-25 02:49:17 +02001170 config.install_signal_handlers = install_sigs;
1171
Victor Stinner331a6a52019-05-27 16:39:22 +02001172 status = Py_InitializeFromConfig(&config);
1173 if (_PyStatus_EXCEPTION(status)) {
1174 Py_ExitStatusException(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001175 }
Nick Coghland6009512014-11-20 21:39:37 +10001176}
1177
1178void
1179Py_Initialize(void)
1180{
1181 Py_InitializeEx(1);
1182}
1183
1184
Nick Coghland6009512014-11-20 21:39:37 +10001185/* Flush stdout and stderr */
1186
1187static int
1188file_is_closed(PyObject *fobj)
1189{
1190 int r;
1191 PyObject *tmp = PyObject_GetAttrString(fobj, "closed");
1192 if (tmp == NULL) {
1193 PyErr_Clear();
1194 return 0;
1195 }
1196 r = PyObject_IsTrue(tmp);
1197 Py_DECREF(tmp);
1198 if (r < 0)
1199 PyErr_Clear();
1200 return r > 0;
1201}
1202
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001203static int
Nick Coghland6009512014-11-20 21:39:37 +10001204flush_std_files(void)
1205{
1206 PyObject *fout = _PySys_GetObjectId(&PyId_stdout);
1207 PyObject *ferr = _PySys_GetObjectId(&PyId_stderr);
1208 PyObject *tmp;
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001209 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001210
1211 if (fout != NULL && fout != Py_None && !file_is_closed(fout)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001212 tmp = _PyObject_CallMethodIdNoArgs(fout, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001213 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001214 PyErr_WriteUnraisable(fout);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001215 status = -1;
1216 }
Nick Coghland6009512014-11-20 21:39:37 +10001217 else
1218 Py_DECREF(tmp);
1219 }
1220
1221 if (ferr != NULL && ferr != Py_None && !file_is_closed(ferr)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001222 tmp = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001223 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001224 PyErr_Clear();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001225 status = -1;
1226 }
Nick Coghland6009512014-11-20 21:39:37 +10001227 else
1228 Py_DECREF(tmp);
1229 }
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001230
1231 return status;
Nick Coghland6009512014-11-20 21:39:37 +10001232}
1233
1234/* Undo the effect of Py_Initialize().
1235
1236 Beware: if multiple interpreter and/or thread states exist, these
1237 are not wiped out; only the current thread and interpreter state
1238 are deleted. But since everything else is deleted, those other
1239 interpreter and thread states should no longer be used.
1240
1241 (XXX We should do better, e.g. wipe out all interpreters and
1242 threads.)
1243
1244 Locking: as above.
1245
1246*/
1247
Victor Stinner7eee5be2019-11-20 10:38:34 +01001248
1249static void
1250finalize_interp_types(PyThreadState *tstate, int is_main_interp)
1251{
Victor Stinner3744ed22020-06-05 01:39:24 +02001252 _PyFrame_Fini(tstate);
Victor Stinner78a02c22020-06-05 02:34:14 +02001253 _PyAsyncGen_Fini(tstate);
Victor Stinnere005ead2020-06-05 02:56:37 +02001254 _PyContext_Fini(tstate);
Victor Stinner7eee5be2019-11-20 10:38:34 +01001255
Victor Stinnerb4e85ca2020-06-23 11:33:18 +02001256 _PyDict_Fini(tstate);
Victor Stinner7907f8c2020-06-08 01:22:36 +02001257 _PyList_Fini(tstate);
1258 _PyTuple_Fini(tstate);
1259
1260 _PySlice_Fini(tstate);
Victor Stinner3d483342019-11-22 12:27:50 +01001261
Victor Stinnerc41eed12020-06-23 15:54:35 +02001262 _PyBytes_Fini(tstate);
Victor Stinner7907f8c2020-06-08 01:22:36 +02001263 _PyUnicode_Fini(tstate);
1264 _PyFloat_Fini(tstate);
1265 _PyLong_Fini(tstate);
Victor Stinner7eee5be2019-11-20 10:38:34 +01001266}
1267
1268
1269static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001270finalize_interp_clear(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001271{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001272 int is_main_interp = _Py_IsMainInterpreter(tstate);
1273
Victor Stinner7eee5be2019-11-20 10:38:34 +01001274 /* Clear interpreter state and all thread states */
1275 PyInterpreterState_Clear(tstate->interp);
1276
Pablo Galindoac0e1c22019-12-04 11:51:03 +00001277 /* Trigger a GC collection on subinterpreters*/
1278 if (!is_main_interp) {
1279 _PyGC_CollectNoFail();
1280 }
1281
Victor Stinner88ec9192020-06-05 02:05:41 +02001282 _PyGC_Fini(tstate);
1283
Victor Stinner7907f8c2020-06-08 01:22:36 +02001284 if (is_main_interp) {
1285 _Py_HashRandomization_Fini();
1286 _PyArg_Fini();
1287 _Py_ClearFileSystemEncoding();
1288 }
1289
1290 _PyWarnings_Fini(tstate->interp);
Victor Stinner7eee5be2019-11-20 10:38:34 +01001291
1292 if (is_main_interp) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001293 _PyExc_Fini();
Victor Stinner7eee5be2019-11-20 10:38:34 +01001294 }
Victor Stinner7907f8c2020-06-08 01:22:36 +02001295
1296 finalize_interp_types(tstate, is_main_interp);
Victor Stinner7eee5be2019-11-20 10:38:34 +01001297}
1298
1299
1300static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001301finalize_interp_delete(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001302{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001303 if (_Py_IsMainInterpreter(tstate)) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001304 /* Cleanup auto-thread-state */
1305 _PyGILState_Fini(tstate);
1306 }
1307
Victor Stinnerdda5d6e2020-04-08 17:54:59 +02001308 /* We can't call _PyEval_FiniGIL() here because destroying the GIL lock can
1309 fail when it is being awaited by another running daemon thread (see
1310 bpo-9901). Instead pycore_create_interpreter() destroys the previously
1311 created GIL, which ensures that Py_Initialize / Py_FinalizeEx can be
1312 called multiple times. */
1313
Victor Stinner7eee5be2019-11-20 10:38:34 +01001314 PyInterpreterState_Delete(tstate->interp);
1315}
1316
1317
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001318int
1319Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001320{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001321 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001322
Victor Stinner8e91c242019-04-24 17:24:01 +02001323 _PyRuntimeState *runtime = &_PyRuntime;
1324 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001325 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001326 }
Nick Coghland6009512014-11-20 21:39:37 +10001327
Victor Stinnere225beb2019-06-03 18:14:24 +02001328 /* Get current thread state and interpreter pointer */
1329 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
1330 PyInterpreterState *interp = tstate->interp;
Victor Stinner8e91c242019-04-24 17:24:01 +02001331
Victor Stinnerb45d2592019-06-20 00:05:23 +02001332 // Wrap up existing "threading"-module-created, non-daemon threads.
1333 wait_for_thread_shutdown(tstate);
1334
1335 // Make any remaining pending calls.
Victor Stinner2b1df452020-01-13 18:46:59 +01001336 _Py_FinishPendingCalls(tstate);
Victor Stinnerb45d2592019-06-20 00:05:23 +02001337
Nick Coghland6009512014-11-20 21:39:37 +10001338 /* The interpreter is still entirely intact at this point, and the
1339 * exit funcs may be relying on that. In particular, if some thread
1340 * or exit func is still waiting to do an import, the import machinery
1341 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001342 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001343 * Note that Threading.py uses an exit func to do a join on all the
1344 * threads created thru it, so this also protects pending imports in
1345 * the threads created via Threading.
1346 */
Nick Coghland6009512014-11-20 21:39:37 +10001347
Victor Stinnerb45d2592019-06-20 00:05:23 +02001348 call_py_exitfuncs(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001349
Victor Stinnerda273412017-12-15 01:46:02 +01001350 /* Copy the core config, PyInterpreterState_Delete() free
1351 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001352#ifdef Py_REF_DEBUG
Victor Stinner331a6a52019-05-27 16:39:22 +02001353 int show_ref_count = interp->config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001354#endif
1355#ifdef Py_TRACE_REFS
Victor Stinner331a6a52019-05-27 16:39:22 +02001356 int dump_refs = interp->config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001357#endif
1358#ifdef WITH_PYMALLOC
Victor Stinner331a6a52019-05-27 16:39:22 +02001359 int malloc_stats = interp->config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001360#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001361
Victor Stinnereb4e2ae2020-03-08 11:57:45 +01001362 /* Remaining daemon threads will automatically exit
1363 when they attempt to take the GIL (ex: PyEval_RestoreThread()). */
Victor Stinner7b3c2522020-03-07 00:24:23 +01001364 _PyRuntimeState_SetFinalizing(runtime, tstate);
Victor Stinner8e91c242019-04-24 17:24:01 +02001365 runtime->initialized = 0;
1366 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001367
Victor Stinner9ad58ac2020-03-09 23:37:49 +01001368 /* Destroy the state of all threads of the interpreter, except of the
1369 current thread. In practice, only daemon threads should still be alive,
1370 except if wait_for_thread_shutdown() has been cancelled by CTRL+C.
1371 Clear frames of other threads to call objects destructors. Destructors
1372 will be called in the current Python thread. Since
1373 _PyRuntimeState_SetFinalizing() has been called, no other Python thread
1374 can take the GIL at this point: if they try, they will exit
1375 immediately. */
1376 _PyThreadState_DeleteExcept(runtime, tstate);
1377
Victor Stinnere0deff32015-03-24 13:46:18 +01001378 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001379 if (flush_std_files() < 0) {
1380 status = -1;
1381 }
Nick Coghland6009512014-11-20 21:39:37 +10001382
1383 /* Disable signal handling */
1384 PyOS_FiniInterrupts();
1385
1386 /* Collect garbage. This may call finalizers; it's nice to call these
1387 * before all modules are destroyed.
1388 * XXX If a __del__ or weakref callback is triggered here, and tries to
1389 * XXX import a module, bad things can happen, because Python no
1390 * XXX longer believes it's initialized.
1391 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1392 * XXX is easy to provoke that way. I've also seen, e.g.,
1393 * XXX Exception exceptions.ImportError: 'No module named sha'
1394 * XXX in <function callback at 0x008F5718> ignored
1395 * XXX but I'm unclear on exactly how that one happens. In any case,
1396 * XXX I haven't seen a real-life report of either of these.
1397 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001398 _PyGC_CollectIfEnabled();
Eric Snowdae02762017-09-14 00:35:58 -07001399
Steve Dowerb82e17e2019-05-23 08:45:22 -07001400 /* Clear all loghooks */
Victor Stinner08faf002020-03-26 18:57:32 +01001401 _PySys_ClearAuditHooks(tstate);
Steve Dowerb82e17e2019-05-23 08:45:22 -07001402
Nick Coghland6009512014-11-20 21:39:37 +10001403 /* Destroy all modules */
Victor Stinner987a0dc2019-06-19 10:36:10 +02001404 _PyImport_Cleanup(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001405
Inada Naoki91234a12019-06-03 21:30:58 +09001406 /* Print debug stats if any */
1407 _PyEval_Fini();
1408
Victor Stinnere0deff32015-03-24 13:46:18 +01001409 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001410 if (flush_std_files() < 0) {
1411 status = -1;
1412 }
Nick Coghland6009512014-11-20 21:39:37 +10001413
1414 /* Collect final garbage. This disposes of cycles created by
1415 * class definitions, for example.
1416 * XXX This is disabled because it caused too many problems. If
1417 * XXX a __del__ or weakref callback triggers here, Python code has
1418 * XXX a hard time running, because even the sys module has been
1419 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1420 * XXX One symptom is a sequence of information-free messages
1421 * XXX coming from threads (if a __del__ or callback is invoked,
1422 * XXX other threads can execute too, and any exception they encounter
1423 * XXX triggers a comedy of errors as subsystem after subsystem
1424 * XXX fails to find what it *expects* to find in sys to help report
1425 * XXX the exception and consequent unexpected failures). I've also
1426 * XXX seen segfaults then, after adding print statements to the
1427 * XXX Python code getting called.
1428 */
1429#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001430 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001431#endif
1432
1433 /* Disable tracemalloc after all Python objects have been destroyed,
1434 so it is possible to use tracemalloc in objects destructor. */
1435 _PyTraceMalloc_Fini();
1436
1437 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1438 _PyImport_Fini();
1439
1440 /* Cleanup typeobject.c's internal caches. */
1441 _PyType_Fini();
1442
1443 /* unload faulthandler module */
1444 _PyFaulthandler_Fini();
1445
Nick Coghland6009512014-11-20 21:39:37 +10001446 /* dump hash stats */
1447 _PyHash_Fini();
1448
Eric Snowdae02762017-09-14 00:35:58 -07001449#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001450 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001451 _PyDebug_PrintTotalRefs();
1452 }
Eric Snowdae02762017-09-14 00:35:58 -07001453#endif
Nick Coghland6009512014-11-20 21:39:37 +10001454
1455#ifdef Py_TRACE_REFS
1456 /* Display all objects still alive -- this can invoke arbitrary
1457 * __repr__ overrides, so requires a mostly-intact interpreter.
1458 * Alas, a lot of stuff may still be alive now that will be cleaned
1459 * up later.
1460 */
Victor Stinnerda273412017-12-15 01:46:02 +01001461 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001462 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001463 }
Nick Coghland6009512014-11-20 21:39:37 +10001464#endif /* Py_TRACE_REFS */
1465
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001466 finalize_interp_clear(tstate);
1467 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001468
1469#ifdef Py_TRACE_REFS
1470 /* Display addresses (& refcnts) of all objects still alive.
1471 * An address can be used to find the repr of the object, printed
1472 * above by _Py_PrintReferences.
1473 */
Victor Stinnerda273412017-12-15 01:46:02 +01001474 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001475 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001476 }
Nick Coghland6009512014-11-20 21:39:37 +10001477#endif /* Py_TRACE_REFS */
Victor Stinner34be807c2016-03-14 12:04:26 +01001478#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001479 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001480 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be807c2016-03-14 12:04:26 +01001481 }
Nick Coghland6009512014-11-20 21:39:37 +10001482#endif
1483
Victor Stinner8e91c242019-04-24 17:24:01 +02001484 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001485
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001486 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001487 return status;
1488}
1489
1490void
1491Py_Finalize(void)
1492{
1493 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001494}
1495
Victor Stinnerb0051362019-11-22 17:52:42 +01001496
Nick Coghland6009512014-11-20 21:39:37 +10001497/* Create and initialize a new interpreter and thread, and return the
1498 new thread. This requires that Py_Initialize() has been called
1499 first.
1500
1501 Unsuccessful initialization yields a NULL pointer. Note that *no*
1502 exception information is available even in this case -- the
1503 exception information is held in the thread, and there is no
1504 thread.
1505
1506 Locking: as above.
1507
1508*/
1509
Victor Stinner331a6a52019-05-27 16:39:22 +02001510static PyStatus
Victor Stinner252346a2020-05-01 11:33:44 +02001511new_interpreter(PyThreadState **tstate_p, int isolated_subinterpreter)
Nick Coghland6009512014-11-20 21:39:37 +10001512{
Victor Stinner331a6a52019-05-27 16:39:22 +02001513 PyStatus status;
Nick Coghland6009512014-11-20 21:39:37 +10001514
Victor Stinner331a6a52019-05-27 16:39:22 +02001515 status = _PyRuntime_Initialize();
1516 if (_PyStatus_EXCEPTION(status)) {
1517 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001518 }
1519 _PyRuntimeState *runtime = &_PyRuntime;
1520
1521 if (!runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001522 return _PyStatus_ERR("Py_Initialize must be called first");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001523 }
Nick Coghland6009512014-11-20 21:39:37 +10001524
Victor Stinner8a1be612016-03-14 22:07:55 +01001525 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1526 interpreters: disable PyGILState_Check(). */
Victor Stinner1c4cbdf2020-04-13 11:45:21 +02001527 runtime->gilstate.check_enabled = 0;
Victor Stinner8a1be612016-03-14 22:07:55 +01001528
Victor Stinner43125222019-04-24 18:23:53 +02001529 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001530 if (interp == NULL) {
1531 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001532 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001533 }
Nick Coghland6009512014-11-20 21:39:37 +10001534
Victor Stinner43125222019-04-24 18:23:53 +02001535 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001536 if (tstate == NULL) {
1537 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001538 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001539 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001540 }
1541
Victor Stinner43125222019-04-24 18:23:53 +02001542 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001543
Eric Snow1abcf672017-05-23 21:46:51 -07001544 /* Copy the current interpreter config into the new interpreter */
Victor Stinnerda7933e2020-04-13 03:04:28 +02001545 const PyConfig *config;
Victor Stinner7be4e352020-05-05 20:27:47 +02001546#ifndef EXPERIMENTAL_ISOLATED_SUBINTERPRETERS
Eric Snow1abcf672017-05-23 21:46:51 -07001547 if (save_tstate != NULL) {
Victor Stinnerda7933e2020-04-13 03:04:28 +02001548 config = _PyInterpreterState_GetConfig(save_tstate->interp);
Victor Stinner7be4e352020-05-05 20:27:47 +02001549 }
1550 else
1551#endif
1552 {
Eric Snow1abcf672017-05-23 21:46:51 -07001553 /* No current thread state, copy from the main interpreter */
1554 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinnerda7933e2020-04-13 03:04:28 +02001555 config = _PyInterpreterState_GetConfig(main_interp);
Victor Stinnerda273412017-12-15 01:46:02 +01001556 }
1557
Victor Stinnerda7933e2020-04-13 03:04:28 +02001558 status = _PyInterpreterState_SetConfig(interp, config);
Victor Stinner331a6a52019-05-27 16:39:22 +02001559 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001560 goto error;
Victor Stinnerda273412017-12-15 01:46:02 +01001561 }
Victor Stinner252346a2020-05-01 11:33:44 +02001562 interp->config._isolated_interpreter = isolated_subinterpreter;
Eric Snow1abcf672017-05-23 21:46:51 -07001563
Victor Stinner0dd5e7a2020-05-05 20:16:37 +02001564 status = init_interp_create_gil(tstate);
1565 if (_PyStatus_EXCEPTION(status)) {
1566 goto error;
1567 }
1568
Victor Stinnerd863ade2019-12-06 03:37:07 +01001569 status = pycore_interp_init(tstate);
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001570 if (_PyStatus_EXCEPTION(status)) {
1571 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001572 }
1573
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001574 status = init_interp_main(tstate);
1575 if (_PyStatus_EXCEPTION(status)) {
1576 goto error;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001577 }
Nick Coghland6009512014-11-20 21:39:37 +10001578
Victor Stinnera7368ac2017-11-15 18:11:45 -08001579 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +02001580 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001581
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001582error:
Victor Stinnerb0051362019-11-22 17:52:42 +01001583 *tstate_p = NULL;
1584
1585 /* Oops, it didn't work. Undo it all. */
Nick Coghland6009512014-11-20 21:39:37 +10001586 PyErr_PrintEx(0);
1587 PyThreadState_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001588 PyThreadState_Delete(tstate);
1589 PyInterpreterState_Delete(interp);
Victor Stinner9da74302019-11-20 11:17:17 +01001590 PyThreadState_Swap(save_tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001591
Victor Stinnerb0051362019-11-22 17:52:42 +01001592 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001593}
1594
1595PyThreadState *
Victor Stinner252346a2020-05-01 11:33:44 +02001596_Py_NewInterpreter(int isolated_subinterpreter)
Victor Stinnera7368ac2017-11-15 18:11:45 -08001597{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001598 PyThreadState *tstate = NULL;
Victor Stinner252346a2020-05-01 11:33:44 +02001599 PyStatus status = new_interpreter(&tstate, isolated_subinterpreter);
Victor Stinner331a6a52019-05-27 16:39:22 +02001600 if (_PyStatus_EXCEPTION(status)) {
1601 Py_ExitStatusException(status);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001602 }
1603 return tstate;
1604
Nick Coghland6009512014-11-20 21:39:37 +10001605}
1606
Victor Stinner252346a2020-05-01 11:33:44 +02001607PyThreadState *
1608Py_NewInterpreter(void)
1609{
1610 return _Py_NewInterpreter(0);
1611}
1612
Nick Coghland6009512014-11-20 21:39:37 +10001613/* Delete an interpreter and its last thread. This requires that the
1614 given thread state is current, that the thread has no remaining
1615 frames, and that it is its interpreter's only remaining thread.
1616 It is a fatal error to violate these constraints.
1617
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001618 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001619 everything, regardless.)
1620
1621 Locking: as above.
1622
1623*/
1624
1625void
1626Py_EndInterpreter(PyThreadState *tstate)
1627{
1628 PyInterpreterState *interp = tstate->interp;
1629
Victor Stinnerb45d2592019-06-20 00:05:23 +02001630 if (tstate != _PyThreadState_GET()) {
Victor Stinner9e5d30c2020-03-07 00:54:20 +01001631 Py_FatalError("thread is not current");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001632 }
1633 if (tstate->frame != NULL) {
Victor Stinner9e5d30c2020-03-07 00:54:20 +01001634 Py_FatalError("thread still has a frame");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001635 }
Eric Snow5be45a62019-03-08 22:47:07 -07001636 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001637
Eric Snow842a2f02019-03-15 15:47:51 -06001638 // Wrap up existing "threading"-module-created, non-daemon threads.
Victor Stinnerb45d2592019-06-20 00:05:23 +02001639 wait_for_thread_shutdown(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001640
Victor Stinnerb45d2592019-06-20 00:05:23 +02001641 call_py_exitfuncs(tstate);
Marcel Plch776407f2017-12-20 11:17:58 +01001642
Victor Stinnerb45d2592019-06-20 00:05:23 +02001643 if (tstate != interp->tstate_head || tstate->next != NULL) {
Victor Stinner9e5d30c2020-03-07 00:54:20 +01001644 Py_FatalError("not the last thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001645 }
Nick Coghland6009512014-11-20 21:39:37 +10001646
Victor Stinner987a0dc2019-06-19 10:36:10 +02001647 _PyImport_Cleanup(tstate);
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001648 finalize_interp_clear(tstate);
1649 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001650}
1651
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001652/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001653
Victor Stinner331a6a52019-05-27 16:39:22 +02001654static PyStatus
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001655add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001656{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001657 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001658 m = PyImport_AddModule("__main__");
1659 if (m == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +02001660 return _PyStatus_ERR("can't create __main__ module");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001661
Nick Coghland6009512014-11-20 21:39:37 +10001662 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001663 ann_dict = PyDict_New();
1664 if ((ann_dict == NULL) ||
1665 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001666 return _PyStatus_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001667 }
1668 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001669
Nick Coghland6009512014-11-20 21:39:37 +10001670 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1671 PyObject *bimod = PyImport_ImportModule("builtins");
1672 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001673 return _PyStatus_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001674 }
1675 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001676 return _PyStatus_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001677 }
1678 Py_DECREF(bimod);
1679 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001680
Nick Coghland6009512014-11-20 21:39:37 +10001681 /* Main is a little special - imp.is_builtin("__main__") will return
1682 * False, but BuiltinImporter is still the most appropriate initial
1683 * setting for its __loader__ attribute. A more suitable value will
1684 * be set if __main__ gets further initialized later in the startup
1685 * process.
1686 */
1687 loader = PyDict_GetItemString(d, "__loader__");
1688 if (loader == NULL || loader == Py_None) {
1689 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1690 "BuiltinImporter");
1691 if (loader == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001692 return _PyStatus_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001693 }
1694 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001695 return _PyStatus_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001696 }
1697 Py_DECREF(loader);
1698 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001699 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001700}
1701
Nick Coghland6009512014-11-20 21:39:37 +10001702/* Import the site module (not into __main__ though) */
1703
Victor Stinner331a6a52019-05-27 16:39:22 +02001704static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001705init_import_site(void)
Nick Coghland6009512014-11-20 21:39:37 +10001706{
1707 PyObject *m;
1708 m = PyImport_ImportModule("site");
1709 if (m == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001710 return _PyStatus_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001711 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001712 Py_DECREF(m);
Victor Stinner331a6a52019-05-27 16:39:22 +02001713 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001714}
1715
Victor Stinner874dbe82015-09-04 17:29:57 +02001716/* Check if a file descriptor is valid or not.
1717 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1718static int
1719is_valid_fd(int fd)
1720{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001721/* dup() is faster than fstat(): fstat() can require input/output operations,
1722 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1723 startup. Problem: dup() doesn't check if the file descriptor is valid on
1724 some platforms.
1725
1726 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1727 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1728 EBADF. FreeBSD has similar issue (bpo-32849).
1729
1730 Only use dup() on platforms where dup() is enough to detect invalid FD in
1731 corner cases: on Linux and Windows (bpo-32849). */
1732#if defined(__linux__) || defined(MS_WINDOWS)
1733 if (fd < 0) {
1734 return 0;
1735 }
1736 int fd2;
1737
1738 _Py_BEGIN_SUPPRESS_IPH
1739 fd2 = dup(fd);
1740 if (fd2 >= 0) {
1741 close(fd2);
1742 }
1743 _Py_END_SUPPRESS_IPH
1744
1745 return (fd2 >= 0);
1746#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001747 struct stat st;
1748 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001749#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001750}
1751
1752/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001753static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02001754create_stdio(const PyConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001755 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001756 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001757{
1758 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1759 const char* mode;
1760 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001761 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001762 int buffering, isatty;
1763 _Py_IDENTIFIER(open);
1764 _Py_IDENTIFIER(isatty);
1765 _Py_IDENTIFIER(TextIOWrapper);
1766 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001767 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001768
Victor Stinner874dbe82015-09-04 17:29:57 +02001769 if (!is_valid_fd(fd))
1770 Py_RETURN_NONE;
1771
Nick Coghland6009512014-11-20 21:39:37 +10001772 /* stdin is always opened in buffered mode, first because it shouldn't
1773 make a difference in common use cases, second because TextIOWrapper
1774 depends on the presence of a read1() method which only exists on
1775 buffered streams.
1776 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001777 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001778 buffering = 0;
1779 else
1780 buffering = -1;
1781 if (write_mode)
1782 mode = "wb";
1783 else
1784 mode = "rb";
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001785 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOO",
Nick Coghland6009512014-11-20 21:39:37 +10001786 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001787 Py_None, Py_None, /* encoding, errors */
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001788 Py_None, Py_False); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001789 if (buf == NULL)
1790 goto error;
1791
1792 if (buffering) {
1793 _Py_IDENTIFIER(raw);
1794 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1795 if (raw == NULL)
1796 goto error;
1797 }
1798 else {
1799 raw = buf;
1800 Py_INCREF(raw);
1801 }
1802
Steve Dower39294992016-08-30 21:22:36 -07001803#ifdef MS_WINDOWS
1804 /* Windows console IO is always UTF-8 encoded */
1805 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001806 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001807#endif
1808
Nick Coghland6009512014-11-20 21:39:37 +10001809 text = PyUnicode_FromString(name);
1810 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1811 goto error;
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001812 res = _PyObject_CallMethodIdNoArgs(raw, &PyId_isatty);
Nick Coghland6009512014-11-20 21:39:37 +10001813 if (res == NULL)
1814 goto error;
1815 isatty = PyObject_IsTrue(res);
1816 Py_DECREF(res);
1817 if (isatty == -1)
1818 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001819 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001820 write_through = Py_True;
1821 else
1822 write_through = Py_False;
Jendrik Seipp5b907712020-01-01 23:21:43 +01001823 if (buffered_stdio && (isatty || fd == fileno(stderr)))
Nick Coghland6009512014-11-20 21:39:37 +10001824 line_buffering = Py_True;
1825 else
1826 line_buffering = Py_False;
1827
1828 Py_CLEAR(raw);
1829 Py_CLEAR(text);
1830
1831#ifdef MS_WINDOWS
1832 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1833 newlines to "\n".
1834 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1835 newline = NULL;
1836#else
1837 /* sys.stdin: split lines at "\n".
1838 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1839 newline = "\n";
1840#endif
1841
Victor Stinner709d23d2019-05-02 14:56:30 -04001842 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1843 if (encoding_str == NULL) {
1844 Py_CLEAR(buf);
1845 goto error;
1846 }
1847
1848 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1849 if (errors_str == NULL) {
1850 Py_CLEAR(buf);
1851 Py_CLEAR(encoding_str);
1852 goto error;
1853 }
1854
1855 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1856 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001857 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001858 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001859 Py_CLEAR(encoding_str);
1860 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001861 if (stream == NULL)
1862 goto error;
1863
1864 if (write_mode)
1865 mode = "w";
1866 else
1867 mode = "r";
1868 text = PyUnicode_FromString(mode);
1869 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1870 goto error;
1871 Py_CLEAR(text);
1872 return stream;
1873
1874error:
1875 Py_XDECREF(buf);
1876 Py_XDECREF(stream);
1877 Py_XDECREF(text);
1878 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001879
Victor Stinner874dbe82015-09-04 17:29:57 +02001880 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1881 /* Issue #24891: the file descriptor was closed after the first
1882 is_valid_fd() check was called. Ignore the OSError and set the
1883 stream to None. */
1884 PyErr_Clear();
1885 Py_RETURN_NONE;
1886 }
1887 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001888}
1889
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001890/* Set builtins.open to io.OpenWrapper */
1891static PyStatus
Andy Lester75cd5bf2020-03-12 02:49:05 -05001892init_set_builtins_open(void)
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001893{
1894 PyObject *iomod = NULL, *wrapper;
1895 PyObject *bimod = NULL;
1896 PyStatus res = _PyStatus_OK();
1897
1898 if (!(iomod = PyImport_ImportModule("io"))) {
1899 goto error;
1900 }
1901
1902 if (!(bimod = PyImport_ImportModule("builtins"))) {
1903 goto error;
1904 }
1905
1906 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1907 goto error;
1908 }
1909
1910 /* Set builtins.open */
1911 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1912 Py_DECREF(wrapper);
1913 goto error;
1914 }
1915 Py_DECREF(wrapper);
1916 goto done;
1917
1918error:
1919 res = _PyStatus_ERR("can't initialize io.open");
1920
1921done:
1922 Py_XDECREF(bimod);
1923 Py_XDECREF(iomod);
1924 return res;
1925}
1926
1927
Nick Coghland6009512014-11-20 21:39:37 +10001928/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinner331a6a52019-05-27 16:39:22 +02001929static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001930init_sys_streams(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10001931{
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001932 PyObject *iomod = NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001933 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001934 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001935 PyObject * encoding_attr;
Victor Stinner331a6a52019-05-27 16:39:22 +02001936 PyStatus res = _PyStatus_OK();
Victor Stinnerda7933e2020-04-13 03:04:28 +02001937 const PyConfig *config = _PyInterpreterState_GetConfig(tstate->interp);
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001938
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001939 /* Check that stdin is not a directory
1940 Using shell redirection, you can redirect stdin to a directory,
1941 crashing the Python interpreter. Catch this common mistake here
1942 and output a useful error message. Note that under MS Windows,
1943 the shell already prevents that. */
1944#ifndef MS_WINDOWS
1945 struct _Py_stat_struct sb;
1946 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1947 S_ISDIR(sb.st_mode)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001948 return _PyStatus_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001949 }
1950#endif
1951
Nick Coghland6009512014-11-20 21:39:37 +10001952 if (!(iomod = PyImport_ImportModule("io"))) {
1953 goto error;
1954 }
Nick Coghland6009512014-11-20 21:39:37 +10001955
Nick Coghland6009512014-11-20 21:39:37 +10001956 /* Set sys.stdin */
1957 fd = fileno(stdin);
1958 /* Under some conditions stdin, stdout and stderr may not be connected
1959 * and fileno() may point to an invalid file descriptor. For example
1960 * GUI apps don't have valid standard streams by default.
1961 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001962 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001963 config->stdio_encoding,
1964 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001965 if (std == NULL)
1966 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001967 PySys_SetObject("__stdin__", std);
1968 _PySys_SetObjectId(&PyId_stdin, std);
1969 Py_DECREF(std);
1970
1971 /* Set sys.stdout */
1972 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001973 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001974 config->stdio_encoding,
1975 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001976 if (std == NULL)
1977 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001978 PySys_SetObject("__stdout__", std);
1979 _PySys_SetObjectId(&PyId_stdout, std);
1980 Py_DECREF(std);
1981
1982#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
1983 /* Set sys.stderr, replaces the preliminary stderr */
1984 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001985 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001986 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04001987 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02001988 if (std == NULL)
1989 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001990
1991 /* Same as hack above, pre-import stderr's codec to avoid recursion
1992 when import.c tries to write to stderr in verbose mode. */
1993 encoding_attr = PyObject_GetAttrString(std, "encoding");
1994 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001995 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10001996 if (std_encoding != NULL) {
1997 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
1998 Py_XDECREF(codec_info);
1999 }
2000 Py_DECREF(encoding_attr);
2001 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02002002 _PyErr_Clear(tstate); /* Not a fatal error if codec isn't available */
Nick Coghland6009512014-11-20 21:39:37 +10002003
2004 if (PySys_SetObject("__stderr__", std) < 0) {
2005 Py_DECREF(std);
2006 goto error;
2007 }
2008 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
2009 Py_DECREF(std);
2010 goto error;
2011 }
2012 Py_DECREF(std);
2013#endif
2014
Victor Stinnera7368ac2017-11-15 18:11:45 -08002015 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10002016
Victor Stinnera7368ac2017-11-15 18:11:45 -08002017error:
Victor Stinner331a6a52019-05-27 16:39:22 +02002018 res = _PyStatus_ERR("can't initialize sys standard streams");
Victor Stinnera7368ac2017-11-15 18:11:45 -08002019
2020done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02002021 _Py_ClearStandardStreamEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10002022 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08002023 return res;
Nick Coghland6009512014-11-20 21:39:37 +10002024}
2025
2026
Victor Stinner10dc4842015-03-24 12:01:30 +01002027static void
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002028_Py_FatalError_DumpTracebacks(int fd, PyInterpreterState *interp,
2029 PyThreadState *tstate)
Victor Stinner10dc4842015-03-24 12:01:30 +01002030{
Victor Stinner10dc4842015-03-24 12:01:30 +01002031 fputc('\n', stderr);
2032 fflush(stderr);
2033
2034 /* display the current Python stack */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002035 _Py_DumpTracebackThreads(fd, interp, tstate);
Victor Stinner10dc4842015-03-24 12:01:30 +01002036}
Victor Stinner791da1c2016-03-14 16:53:12 +01002037
2038/* Print the current exception (if an exception is set) with its traceback,
2039 or display the current Python stack.
2040
2041 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
2042 called on catastrophic cases.
2043
2044 Return 1 if the traceback was displayed, 0 otherwise. */
2045
2046static int
Andy Lester75cd5bf2020-03-12 02:49:05 -05002047_Py_FatalError_PrintExc(PyThreadState *tstate)
Victor Stinner791da1c2016-03-14 16:53:12 +01002048{
2049 PyObject *ferr, *res;
2050 PyObject *exception, *v, *tb;
2051 int has_tb;
2052
Victor Stinnerb45d2592019-06-20 00:05:23 +02002053 _PyErr_Fetch(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002054 if (exception == NULL) {
2055 /* No current exception */
2056 return 0;
2057 }
2058
2059 ferr = _PySys_GetObjectId(&PyId_stderr);
2060 if (ferr == NULL || ferr == Py_None) {
2061 /* sys.stderr is not set yet or set to None,
2062 no need to try to display the exception */
2063 return 0;
2064 }
2065
Victor Stinnerb45d2592019-06-20 00:05:23 +02002066 _PyErr_NormalizeException(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002067 if (tb == NULL) {
2068 tb = Py_None;
2069 Py_INCREF(tb);
2070 }
2071 PyException_SetTraceback(v, tb);
2072 if (exception == NULL) {
2073 /* PyErr_NormalizeException() failed */
2074 return 0;
2075 }
2076
2077 has_tb = (tb != Py_None);
2078 PyErr_Display(exception, v, tb);
2079 Py_XDECREF(exception);
2080 Py_XDECREF(v);
2081 Py_XDECREF(tb);
2082
2083 /* sys.stderr may be buffered: call sys.stderr.flush() */
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002084 res = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002085 if (res == NULL) {
2086 _PyErr_Clear(tstate);
2087 }
2088 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002089 Py_DECREF(res);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002090 }
Victor Stinner791da1c2016-03-14 16:53:12 +01002091
2092 return has_tb;
2093}
2094
Nick Coghland6009512014-11-20 21:39:37 +10002095/* Print fatal error message and abort */
2096
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002097#ifdef MS_WINDOWS
2098static void
2099fatal_output_debug(const char *msg)
2100{
2101 /* buffer of 256 bytes allocated on the stack */
2102 WCHAR buffer[256 / sizeof(WCHAR)];
2103 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2104 size_t msglen;
2105
2106 OutputDebugStringW(L"Fatal Python error: ");
2107
2108 msglen = strlen(msg);
2109 while (msglen) {
2110 size_t i;
2111
2112 if (buflen > msglen) {
2113 buflen = msglen;
2114 }
2115
2116 /* Convert the message to wchar_t. This uses a simple one-to-one
2117 conversion, assuming that the this error message actually uses
2118 ASCII only. If this ceases to be true, we will have to convert. */
2119 for (i=0; i < buflen; ++i) {
2120 buffer[i] = msg[i];
2121 }
2122 buffer[i] = L'\0';
2123 OutputDebugStringW(buffer);
2124
2125 msg += buflen;
2126 msglen -= buflen;
2127 }
2128 OutputDebugStringW(L"\n");
2129}
2130#endif
2131
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002132
2133static void
2134fatal_error_dump_runtime(FILE *stream, _PyRuntimeState *runtime)
2135{
2136 fprintf(stream, "Python runtime state: ");
Victor Stinner7b3c2522020-03-07 00:24:23 +01002137 PyThreadState *finalizing = _PyRuntimeState_GetFinalizing(runtime);
2138 if (finalizing) {
2139 fprintf(stream, "finalizing (tstate=%p)", finalizing);
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002140 }
2141 else if (runtime->initialized) {
2142 fprintf(stream, "initialized");
2143 }
2144 else if (runtime->core_initialized) {
2145 fprintf(stream, "core initialized");
2146 }
2147 else if (runtime->preinitialized) {
2148 fprintf(stream, "preinitialized");
2149 }
2150 else if (runtime->preinitializing) {
2151 fprintf(stream, "preinitializing");
2152 }
2153 else {
2154 fprintf(stream, "unknown");
2155 }
2156 fprintf(stream, "\n");
2157 fflush(stream);
2158}
2159
2160
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002161static inline void _Py_NO_RETURN
2162fatal_error_exit(int status)
Nick Coghland6009512014-11-20 21:39:37 +10002163{
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002164 if (status < 0) {
2165#if defined(MS_WINDOWS) && defined(_DEBUG)
2166 DebugBreak();
2167#endif
2168 abort();
2169 }
2170 else {
2171 exit(status);
2172 }
2173}
2174
2175
2176static void _Py_NO_RETURN
2177fatal_error(FILE *stream, int header, const char *prefix, const char *msg,
2178 int status)
2179{
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002180 const int fd = fileno(stream);
Victor Stinner53345a42015-03-25 01:55:14 +01002181 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002182
2183 if (reentrant) {
2184 /* Py_FatalError() caused a second fatal error.
2185 Example: flush_std_files() raises a recursion error. */
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002186 fatal_error_exit(status);
Victor Stinner53345a42015-03-25 01:55:14 +01002187 }
2188 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002189
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002190 if (header) {
2191 fprintf(stream, "Fatal Python error: ");
2192 if (prefix) {
2193 fputs(prefix, stream);
2194 fputs(": ", stream);
2195 }
2196 if (msg) {
2197 fputs(msg, stream);
2198 }
2199 else {
2200 fprintf(stream, "<message not set>");
2201 }
2202 fputs("\n", stream);
2203 fflush(stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002204 }
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002205
2206 _PyRuntimeState *runtime = &_PyRuntime;
2207 fatal_error_dump_runtime(stream, runtime);
2208
2209 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
2210 PyInterpreterState *interp = NULL;
2211 if (tstate != NULL) {
2212 interp = tstate->interp;
2213 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002214
Victor Stinner3a228ab2018-11-01 00:26:41 +01002215 /* Check if the current thread has a Python thread state
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002216 and holds the GIL.
Victor Stinner3a228ab2018-11-01 00:26:41 +01002217
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002218 tss_tstate is NULL if Py_FatalError() is called from a C thread which
2219 has no Python thread state.
2220
2221 tss_tstate != tstate if the current Python thread does not hold the GIL.
2222 */
2223 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2224 int has_tstate_and_gil = (tss_tstate != NULL && tss_tstate == tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002225 if (has_tstate_and_gil) {
2226 /* If an exception is set, print the exception with its traceback */
Andy Lester75cd5bf2020-03-12 02:49:05 -05002227 if (!_Py_FatalError_PrintExc(tss_tstate)) {
Victor Stinner3a228ab2018-11-01 00:26:41 +01002228 /* No exception is set, or an exception is set without traceback */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002229 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002230 }
2231 }
2232 else {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002233 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002234 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002235
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002236 /* The main purpose of faulthandler is to display the traceback.
2237 This function already did its best to display a traceback.
2238 Disable faulthandler to prevent writing a second traceback
2239 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002240 _PyFaulthandler_Fini();
2241
Victor Stinner791da1c2016-03-14 16:53:12 +01002242 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002243 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002244 /* Flush sys.stdout and sys.stderr */
2245 flush_std_files();
2246 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002247
Nick Coghland6009512014-11-20 21:39:37 +10002248#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002249 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002250#endif /* MS_WINDOWS */
2251
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002252 fatal_error_exit(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002253}
2254
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002255
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002256#undef Py_FatalError
2257
Victor Stinner19760862017-12-20 01:41:59 +01002258void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002259Py_FatalError(const char *msg)
2260{
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002261 fatal_error(stderr, 1, NULL, msg, -1);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002262}
2263
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002264
Victor Stinner19760862017-12-20 01:41:59 +01002265void _Py_NO_RETURN
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002266_Py_FatalErrorFunc(const char *func, const char *msg)
2267{
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002268 fatal_error(stderr, 1, func, msg, -1);
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002269}
2270
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002271
2272void _Py_NO_RETURN
2273_Py_FatalErrorFormat(const char *func, const char *format, ...)
2274{
2275 static int reentrant = 0;
2276 if (reentrant) {
2277 /* _Py_FatalErrorFormat() caused a second fatal error */
2278 fatal_error_exit(-1);
2279 }
2280 reentrant = 1;
2281
2282 FILE *stream = stderr;
2283 fprintf(stream, "Fatal Python error: ");
2284 if (func) {
2285 fputs(func, stream);
2286 fputs(": ", stream);
2287 }
2288 fflush(stream);
2289
2290 va_list vargs;
2291#ifdef HAVE_STDARG_PROTOTYPES
2292 va_start(vargs, format);
2293#else
2294 va_start(vargs);
2295#endif
2296 vfprintf(stream, format, vargs);
2297 va_end(vargs);
2298
2299 fputs("\n", stream);
2300 fflush(stream);
2301
2302 fatal_error(stream, 0, NULL, NULL, -1);
2303}
2304
2305
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002306void _Py_NO_RETURN
Victor Stinner331a6a52019-05-27 16:39:22 +02002307Py_ExitStatusException(PyStatus status)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002308{
Victor Stinner331a6a52019-05-27 16:39:22 +02002309 if (_PyStatus_IS_EXIT(status)) {
2310 exit(status.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002311 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002312 else if (_PyStatus_IS_ERROR(status)) {
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002313 fatal_error(stderr, 1, status.func, status.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002314 }
2315 else {
Victor Stinner331a6a52019-05-27 16:39:22 +02002316 Py_FatalError("Py_ExitStatusException() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002317 }
Nick Coghland6009512014-11-20 21:39:37 +10002318}
2319
2320/* Clean up and exit */
2321
Nick Coghland6009512014-11-20 21:39:37 +10002322/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002323void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002324{
Victor Stinner81a7be32020-04-14 15:14:01 +02002325 PyInterpreterState *is = _PyInterpreterState_GET();
Marcel Plch776407f2017-12-20 11:17:58 +01002326
Antoine Pitroufc5db952017-12-13 02:29:07 +01002327 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002328 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2329
2330 is->pyexitfunc = func;
2331 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002332}
2333
2334static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002335call_py_exitfuncs(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002336{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002337 PyInterpreterState *interp = tstate->interp;
2338 if (interp->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002339 return;
2340
Victor Stinnerb45d2592019-06-20 00:05:23 +02002341 (*interp->pyexitfunc)(interp->pyexitmodule);
2342 _PyErr_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10002343}
2344
2345/* Wait until threading._shutdown completes, provided
2346 the threading module was imported in the first place.
2347 The shutdown routine will wait until all non-daemon
2348 "threading" threads have completed. */
2349static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002350wait_for_thread_shutdown(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002351{
Nick Coghland6009512014-11-20 21:39:37 +10002352 _Py_IDENTIFIER(_shutdown);
2353 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002354 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002355 if (threading == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +02002356 if (_PyErr_Occurred(tstate)) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002357 PyErr_WriteUnraisable(NULL);
2358 }
2359 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002360 return;
2361 }
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002362 result = _PyObject_CallMethodIdNoArgs(threading, &PyId__shutdown);
Nick Coghland6009512014-11-20 21:39:37 +10002363 if (result == NULL) {
2364 PyErr_WriteUnraisable(threading);
2365 }
2366 else {
2367 Py_DECREF(result);
2368 }
2369 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002370}
2371
2372#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002373int Py_AtExit(void (*func)(void))
2374{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002375 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002376 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002377 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002378 return 0;
2379}
2380
2381static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002382call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002383{
Victor Stinner8e91c242019-04-24 17:24:01 +02002384 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002385 /* pop last function from the list */
2386 runtime->nexitfuncs--;
2387 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2388 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2389
2390 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002391 }
Nick Coghland6009512014-11-20 21:39:37 +10002392
2393 fflush(stdout);
2394 fflush(stderr);
2395}
2396
Victor Stinnercfc88312018-08-01 16:41:25 +02002397void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002398Py_Exit(int sts)
2399{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002400 if (Py_FinalizeEx() < 0) {
2401 sts = 120;
2402 }
Nick Coghland6009512014-11-20 21:39:37 +10002403
2404 exit(sts);
2405}
2406
Victor Stinner331a6a52019-05-27 16:39:22 +02002407static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02002408init_signals(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002409{
2410#ifdef SIGPIPE
2411 PyOS_setsig(SIGPIPE, SIG_IGN);
2412#endif
2413#ifdef SIGXFZ
2414 PyOS_setsig(SIGXFZ, SIG_IGN);
2415#endif
2416#ifdef SIGXFSZ
2417 PyOS_setsig(SIGXFSZ, SIG_IGN);
2418#endif
Victor Stinner400e1db2020-03-31 19:13:10 +02002419 PyOS_InitInterrupts(); /* May imply init_signals() */
Victor Stinnerb45d2592019-06-20 00:05:23 +02002420 if (_PyErr_Occurred(tstate)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002421 return _PyStatus_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002422 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002423 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002424}
2425
2426
2427/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2428 *
2429 * All of the code in this function must only use async-signal-safe functions,
2430 * listed at `man 7 signal` or
2431 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
Victor Stinnerefc28bb2020-03-05 18:13:56 +01002432 *
2433 * If this function is updated, update also _posix_spawn() of subprocess.py.
Nick Coghland6009512014-11-20 21:39:37 +10002434 */
2435void
2436_Py_RestoreSignals(void)
2437{
2438#ifdef SIGPIPE
2439 PyOS_setsig(SIGPIPE, SIG_DFL);
2440#endif
2441#ifdef SIGXFZ
2442 PyOS_setsig(SIGXFZ, SIG_DFL);
2443#endif
2444#ifdef SIGXFSZ
2445 PyOS_setsig(SIGXFSZ, SIG_DFL);
2446#endif
2447}
2448
2449
2450/*
2451 * The file descriptor fd is considered ``interactive'' if either
2452 * a) isatty(fd) is TRUE, or
2453 * b) the -i flag was given, and the filename associated with
2454 * the descriptor is NULL or "<stdin>" or "???".
2455 */
2456int
2457Py_FdIsInteractive(FILE *fp, const char *filename)
2458{
2459 if (isatty((int)fileno(fp)))
2460 return 1;
2461 if (!Py_InteractiveFlag)
2462 return 0;
2463 return (filename == NULL) ||
2464 (strcmp(filename, "<stdin>") == 0) ||
2465 (strcmp(filename, "???") == 0);
2466}
2467
2468
Nick Coghland6009512014-11-20 21:39:37 +10002469/* Wrappers around sigaction() or signal(). */
2470
2471PyOS_sighandler_t
2472PyOS_getsig(int sig)
2473{
2474#ifdef HAVE_SIGACTION
2475 struct sigaction context;
2476 if (sigaction(sig, NULL, &context) == -1)
2477 return SIG_ERR;
2478 return context.sa_handler;
2479#else
2480 PyOS_sighandler_t handler;
2481/* Special signal handling for the secure CRT in Visual Studio 2005 */
2482#if defined(_MSC_VER) && _MSC_VER >= 1400
2483 switch (sig) {
2484 /* Only these signals are valid */
2485 case SIGINT:
2486 case SIGILL:
2487 case SIGFPE:
2488 case SIGSEGV:
2489 case SIGTERM:
2490 case SIGBREAK:
2491 case SIGABRT:
2492 break;
2493 /* Don't call signal() with other values or it will assert */
2494 default:
2495 return SIG_ERR;
2496 }
2497#endif /* _MSC_VER && _MSC_VER >= 1400 */
2498 handler = signal(sig, SIG_IGN);
2499 if (handler != SIG_ERR)
2500 signal(sig, handler);
2501 return handler;
2502#endif
2503}
2504
2505/*
2506 * All of the code in this function must only use async-signal-safe functions,
2507 * listed at `man 7 signal` or
2508 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2509 */
2510PyOS_sighandler_t
2511PyOS_setsig(int sig, PyOS_sighandler_t handler)
2512{
2513#ifdef HAVE_SIGACTION
2514 /* Some code in Modules/signalmodule.c depends on sigaction() being
2515 * used here if HAVE_SIGACTION is defined. Fix that if this code
2516 * changes to invalidate that assumption.
2517 */
2518 struct sigaction context, ocontext;
2519 context.sa_handler = handler;
2520 sigemptyset(&context.sa_mask);
2521 context.sa_flags = 0;
2522 if (sigaction(sig, &context, &ocontext) == -1)
2523 return SIG_ERR;
2524 return ocontext.sa_handler;
2525#else
2526 PyOS_sighandler_t oldhandler;
2527 oldhandler = signal(sig, handler);
2528#ifdef HAVE_SIGINTERRUPT
2529 siginterrupt(sig, 1);
2530#endif
2531 return oldhandler;
2532#endif
2533}
2534
2535#ifdef __cplusplus
2536}
2537#endif