blob: f0b40b3aa68e320310eb146ab2bc3b635475d484 [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 Stinner281cce12020-06-23 22:55:46 +0200605 status = _PyExc_Init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200606 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 Stinner281cce12020-06-23 22:55:46 +02001252 _PyExc_Fini(tstate);
Victor Stinner3744ed22020-06-05 01:39:24 +02001253 _PyFrame_Fini(tstate);
Victor Stinner78a02c22020-06-05 02:34:14 +02001254 _PyAsyncGen_Fini(tstate);
Victor Stinnere005ead2020-06-05 02:56:37 +02001255 _PyContext_Fini(tstate);
Victor Stinner7eee5be2019-11-20 10:38:34 +01001256
Victor Stinnerb4e85ca2020-06-23 11:33:18 +02001257 _PyDict_Fini(tstate);
Victor Stinner7907f8c2020-06-08 01:22:36 +02001258 _PyList_Fini(tstate);
1259 _PyTuple_Fini(tstate);
1260
1261 _PySlice_Fini(tstate);
Victor Stinner3d483342019-11-22 12:27:50 +01001262
Victor Stinnerc41eed12020-06-23 15:54:35 +02001263 _PyBytes_Fini(tstate);
Victor Stinner7907f8c2020-06-08 01:22:36 +02001264 _PyUnicode_Fini(tstate);
1265 _PyFloat_Fini(tstate);
1266 _PyLong_Fini(tstate);
Victor Stinner7eee5be2019-11-20 10:38:34 +01001267}
1268
1269
1270static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001271finalize_interp_clear(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001272{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001273 int is_main_interp = _Py_IsMainInterpreter(tstate);
1274
Victor Stinner7eee5be2019-11-20 10:38:34 +01001275 /* Clear interpreter state and all thread states */
1276 PyInterpreterState_Clear(tstate->interp);
1277
Pablo Galindoac0e1c22019-12-04 11:51:03 +00001278 /* Trigger a GC collection on subinterpreters*/
1279 if (!is_main_interp) {
1280 _PyGC_CollectNoFail();
1281 }
1282
Victor Stinner88ec9192020-06-05 02:05:41 +02001283 _PyGC_Fini(tstate);
1284
Victor Stinner7907f8c2020-06-08 01:22:36 +02001285 if (is_main_interp) {
1286 _Py_HashRandomization_Fini();
1287 _PyArg_Fini();
1288 _Py_ClearFileSystemEncoding();
1289 }
1290
1291 _PyWarnings_Fini(tstate->interp);
Victor Stinner7eee5be2019-11-20 10:38:34 +01001292
Victor Stinner7907f8c2020-06-08 01:22:36 +02001293 finalize_interp_types(tstate, is_main_interp);
Victor Stinner7eee5be2019-11-20 10:38:34 +01001294}
1295
1296
1297static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001298finalize_interp_delete(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001299{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001300 if (_Py_IsMainInterpreter(tstate)) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001301 /* Cleanup auto-thread-state */
1302 _PyGILState_Fini(tstate);
1303 }
1304
Victor Stinnerdda5d6e2020-04-08 17:54:59 +02001305 /* We can't call _PyEval_FiniGIL() here because destroying the GIL lock can
1306 fail when it is being awaited by another running daemon thread (see
1307 bpo-9901). Instead pycore_create_interpreter() destroys the previously
1308 created GIL, which ensures that Py_Initialize / Py_FinalizeEx can be
1309 called multiple times. */
1310
Victor Stinner7eee5be2019-11-20 10:38:34 +01001311 PyInterpreterState_Delete(tstate->interp);
1312}
1313
1314
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001315int
1316Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001317{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001318 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001319
Victor Stinner8e91c242019-04-24 17:24:01 +02001320 _PyRuntimeState *runtime = &_PyRuntime;
1321 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001322 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001323 }
Nick Coghland6009512014-11-20 21:39:37 +10001324
Victor Stinnere225beb2019-06-03 18:14:24 +02001325 /* Get current thread state and interpreter pointer */
1326 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
1327 PyInterpreterState *interp = tstate->interp;
Victor Stinner8e91c242019-04-24 17:24:01 +02001328
Victor Stinnerb45d2592019-06-20 00:05:23 +02001329 // Wrap up existing "threading"-module-created, non-daemon threads.
1330 wait_for_thread_shutdown(tstate);
1331
1332 // Make any remaining pending calls.
Victor Stinner2b1df452020-01-13 18:46:59 +01001333 _Py_FinishPendingCalls(tstate);
Victor Stinnerb45d2592019-06-20 00:05:23 +02001334
Nick Coghland6009512014-11-20 21:39:37 +10001335 /* The interpreter is still entirely intact at this point, and the
1336 * exit funcs may be relying on that. In particular, if some thread
1337 * or exit func is still waiting to do an import, the import machinery
1338 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001339 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001340 * Note that Threading.py uses an exit func to do a join on all the
1341 * threads created thru it, so this also protects pending imports in
1342 * the threads created via Threading.
1343 */
Nick Coghland6009512014-11-20 21:39:37 +10001344
Victor Stinnerb45d2592019-06-20 00:05:23 +02001345 call_py_exitfuncs(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001346
Victor Stinnerda273412017-12-15 01:46:02 +01001347 /* Copy the core config, PyInterpreterState_Delete() free
1348 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001349#ifdef Py_REF_DEBUG
Victor Stinner331a6a52019-05-27 16:39:22 +02001350 int show_ref_count = interp->config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001351#endif
1352#ifdef Py_TRACE_REFS
Victor Stinner331a6a52019-05-27 16:39:22 +02001353 int dump_refs = interp->config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001354#endif
1355#ifdef WITH_PYMALLOC
Victor Stinner331a6a52019-05-27 16:39:22 +02001356 int malloc_stats = interp->config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001357#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001358
Victor Stinnereb4e2ae2020-03-08 11:57:45 +01001359 /* Remaining daemon threads will automatically exit
1360 when they attempt to take the GIL (ex: PyEval_RestoreThread()). */
Victor Stinner7b3c2522020-03-07 00:24:23 +01001361 _PyRuntimeState_SetFinalizing(runtime, tstate);
Victor Stinner8e91c242019-04-24 17:24:01 +02001362 runtime->initialized = 0;
1363 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001364
Victor Stinner9ad58ac2020-03-09 23:37:49 +01001365 /* Destroy the state of all threads of the interpreter, except of the
1366 current thread. In practice, only daemon threads should still be alive,
1367 except if wait_for_thread_shutdown() has been cancelled by CTRL+C.
1368 Clear frames of other threads to call objects destructors. Destructors
1369 will be called in the current Python thread. Since
1370 _PyRuntimeState_SetFinalizing() has been called, no other Python thread
1371 can take the GIL at this point: if they try, they will exit
1372 immediately. */
1373 _PyThreadState_DeleteExcept(runtime, tstate);
1374
Victor Stinnere0deff32015-03-24 13:46:18 +01001375 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001376 if (flush_std_files() < 0) {
1377 status = -1;
1378 }
Nick Coghland6009512014-11-20 21:39:37 +10001379
1380 /* Disable signal handling */
1381 PyOS_FiniInterrupts();
1382
1383 /* Collect garbage. This may call finalizers; it's nice to call these
1384 * before all modules are destroyed.
1385 * XXX If a __del__ or weakref callback is triggered here, and tries to
1386 * XXX import a module, bad things can happen, because Python no
1387 * XXX longer believes it's initialized.
1388 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1389 * XXX is easy to provoke that way. I've also seen, e.g.,
1390 * XXX Exception exceptions.ImportError: 'No module named sha'
1391 * XXX in <function callback at 0x008F5718> ignored
1392 * XXX but I'm unclear on exactly how that one happens. In any case,
1393 * XXX I haven't seen a real-life report of either of these.
1394 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001395 _PyGC_CollectIfEnabled();
Eric Snowdae02762017-09-14 00:35:58 -07001396
Steve Dowerb82e17e2019-05-23 08:45:22 -07001397 /* Clear all loghooks */
Victor Stinner08faf002020-03-26 18:57:32 +01001398 _PySys_ClearAuditHooks(tstate);
Steve Dowerb82e17e2019-05-23 08:45:22 -07001399
Nick Coghland6009512014-11-20 21:39:37 +10001400 /* Destroy all modules */
Victor Stinner987a0dc2019-06-19 10:36:10 +02001401 _PyImport_Cleanup(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001402
Inada Naoki91234a12019-06-03 21:30:58 +09001403 /* Print debug stats if any */
1404 _PyEval_Fini();
1405
Victor Stinnere0deff32015-03-24 13:46:18 +01001406 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001407 if (flush_std_files() < 0) {
1408 status = -1;
1409 }
Nick Coghland6009512014-11-20 21:39:37 +10001410
1411 /* Collect final garbage. This disposes of cycles created by
1412 * class definitions, for example.
1413 * XXX This is disabled because it caused too many problems. If
1414 * XXX a __del__ or weakref callback triggers here, Python code has
1415 * XXX a hard time running, because even the sys module has been
1416 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1417 * XXX One symptom is a sequence of information-free messages
1418 * XXX coming from threads (if a __del__ or callback is invoked,
1419 * XXX other threads can execute too, and any exception they encounter
1420 * XXX triggers a comedy of errors as subsystem after subsystem
1421 * XXX fails to find what it *expects* to find in sys to help report
1422 * XXX the exception and consequent unexpected failures). I've also
1423 * XXX seen segfaults then, after adding print statements to the
1424 * XXX Python code getting called.
1425 */
1426#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001427 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001428#endif
1429
1430 /* Disable tracemalloc after all Python objects have been destroyed,
1431 so it is possible to use tracemalloc in objects destructor. */
1432 _PyTraceMalloc_Fini();
1433
1434 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1435 _PyImport_Fini();
1436
1437 /* Cleanup typeobject.c's internal caches. */
1438 _PyType_Fini();
1439
1440 /* unload faulthandler module */
1441 _PyFaulthandler_Fini();
1442
Nick Coghland6009512014-11-20 21:39:37 +10001443 /* dump hash stats */
1444 _PyHash_Fini();
1445
Eric Snowdae02762017-09-14 00:35:58 -07001446#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001447 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001448 _PyDebug_PrintTotalRefs();
1449 }
Eric Snowdae02762017-09-14 00:35:58 -07001450#endif
Nick Coghland6009512014-11-20 21:39:37 +10001451
1452#ifdef Py_TRACE_REFS
1453 /* Display all objects still alive -- this can invoke arbitrary
1454 * __repr__ overrides, so requires a mostly-intact interpreter.
1455 * Alas, a lot of stuff may still be alive now that will be cleaned
1456 * up later.
1457 */
Victor Stinnerda273412017-12-15 01:46:02 +01001458 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001459 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001460 }
Nick Coghland6009512014-11-20 21:39:37 +10001461#endif /* Py_TRACE_REFS */
1462
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001463 finalize_interp_clear(tstate);
1464 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001465
1466#ifdef Py_TRACE_REFS
1467 /* Display addresses (& refcnts) of all objects still alive.
1468 * An address can be used to find the repr of the object, printed
1469 * above by _Py_PrintReferences.
1470 */
Victor Stinnerda273412017-12-15 01:46:02 +01001471 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001472 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001473 }
Nick Coghland6009512014-11-20 21:39:37 +10001474#endif /* Py_TRACE_REFS */
Victor Stinner34be807c2016-03-14 12:04:26 +01001475#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001476 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001477 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be807c2016-03-14 12:04:26 +01001478 }
Nick Coghland6009512014-11-20 21:39:37 +10001479#endif
1480
Victor Stinner8e91c242019-04-24 17:24:01 +02001481 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001482
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001483 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001484 return status;
1485}
1486
1487void
1488Py_Finalize(void)
1489{
1490 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001491}
1492
Victor Stinnerb0051362019-11-22 17:52:42 +01001493
Nick Coghland6009512014-11-20 21:39:37 +10001494/* Create and initialize a new interpreter and thread, and return the
1495 new thread. This requires that Py_Initialize() has been called
1496 first.
1497
1498 Unsuccessful initialization yields a NULL pointer. Note that *no*
1499 exception information is available even in this case -- the
1500 exception information is held in the thread, and there is no
1501 thread.
1502
1503 Locking: as above.
1504
1505*/
1506
Victor Stinner331a6a52019-05-27 16:39:22 +02001507static PyStatus
Victor Stinner252346a2020-05-01 11:33:44 +02001508new_interpreter(PyThreadState **tstate_p, int isolated_subinterpreter)
Nick Coghland6009512014-11-20 21:39:37 +10001509{
Victor Stinner331a6a52019-05-27 16:39:22 +02001510 PyStatus status;
Nick Coghland6009512014-11-20 21:39:37 +10001511
Victor Stinner331a6a52019-05-27 16:39:22 +02001512 status = _PyRuntime_Initialize();
1513 if (_PyStatus_EXCEPTION(status)) {
1514 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001515 }
1516 _PyRuntimeState *runtime = &_PyRuntime;
1517
1518 if (!runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001519 return _PyStatus_ERR("Py_Initialize must be called first");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001520 }
Nick Coghland6009512014-11-20 21:39:37 +10001521
Victor Stinner8a1be612016-03-14 22:07:55 +01001522 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1523 interpreters: disable PyGILState_Check(). */
Victor Stinner1c4cbdf2020-04-13 11:45:21 +02001524 runtime->gilstate.check_enabled = 0;
Victor Stinner8a1be612016-03-14 22:07:55 +01001525
Victor Stinner43125222019-04-24 18:23:53 +02001526 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001527 if (interp == NULL) {
1528 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001529 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001530 }
Nick Coghland6009512014-11-20 21:39:37 +10001531
Victor Stinner43125222019-04-24 18:23:53 +02001532 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001533 if (tstate == NULL) {
1534 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001535 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001536 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001537 }
1538
Victor Stinner43125222019-04-24 18:23:53 +02001539 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001540
Eric Snow1abcf672017-05-23 21:46:51 -07001541 /* Copy the current interpreter config into the new interpreter */
Victor Stinnerda7933e2020-04-13 03:04:28 +02001542 const PyConfig *config;
Victor Stinner7be4e352020-05-05 20:27:47 +02001543#ifndef EXPERIMENTAL_ISOLATED_SUBINTERPRETERS
Eric Snow1abcf672017-05-23 21:46:51 -07001544 if (save_tstate != NULL) {
Victor Stinnerda7933e2020-04-13 03:04:28 +02001545 config = _PyInterpreterState_GetConfig(save_tstate->interp);
Victor Stinner7be4e352020-05-05 20:27:47 +02001546 }
1547 else
1548#endif
1549 {
Eric Snow1abcf672017-05-23 21:46:51 -07001550 /* No current thread state, copy from the main interpreter */
1551 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinnerda7933e2020-04-13 03:04:28 +02001552 config = _PyInterpreterState_GetConfig(main_interp);
Victor Stinnerda273412017-12-15 01:46:02 +01001553 }
1554
Victor Stinnerda7933e2020-04-13 03:04:28 +02001555 status = _PyInterpreterState_SetConfig(interp, config);
Victor Stinner331a6a52019-05-27 16:39:22 +02001556 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001557 goto error;
Victor Stinnerda273412017-12-15 01:46:02 +01001558 }
Victor Stinner252346a2020-05-01 11:33:44 +02001559 interp->config._isolated_interpreter = isolated_subinterpreter;
Eric Snow1abcf672017-05-23 21:46:51 -07001560
Victor Stinner0dd5e7a2020-05-05 20:16:37 +02001561 status = init_interp_create_gil(tstate);
1562 if (_PyStatus_EXCEPTION(status)) {
1563 goto error;
1564 }
1565
Victor Stinnerd863ade2019-12-06 03:37:07 +01001566 status = pycore_interp_init(tstate);
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001567 if (_PyStatus_EXCEPTION(status)) {
1568 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001569 }
1570
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001571 status = init_interp_main(tstate);
1572 if (_PyStatus_EXCEPTION(status)) {
1573 goto error;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001574 }
Nick Coghland6009512014-11-20 21:39:37 +10001575
Victor Stinnera7368ac2017-11-15 18:11:45 -08001576 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +02001577 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001578
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001579error:
Victor Stinnerb0051362019-11-22 17:52:42 +01001580 *tstate_p = NULL;
1581
1582 /* Oops, it didn't work. Undo it all. */
Nick Coghland6009512014-11-20 21:39:37 +10001583 PyErr_PrintEx(0);
1584 PyThreadState_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001585 PyThreadState_Delete(tstate);
1586 PyInterpreterState_Delete(interp);
Victor Stinner9da74302019-11-20 11:17:17 +01001587 PyThreadState_Swap(save_tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001588
Victor Stinnerb0051362019-11-22 17:52:42 +01001589 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001590}
1591
1592PyThreadState *
Victor Stinner252346a2020-05-01 11:33:44 +02001593_Py_NewInterpreter(int isolated_subinterpreter)
Victor Stinnera7368ac2017-11-15 18:11:45 -08001594{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001595 PyThreadState *tstate = NULL;
Victor Stinner252346a2020-05-01 11:33:44 +02001596 PyStatus status = new_interpreter(&tstate, isolated_subinterpreter);
Victor Stinner331a6a52019-05-27 16:39:22 +02001597 if (_PyStatus_EXCEPTION(status)) {
1598 Py_ExitStatusException(status);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001599 }
1600 return tstate;
1601
Nick Coghland6009512014-11-20 21:39:37 +10001602}
1603
Victor Stinner252346a2020-05-01 11:33:44 +02001604PyThreadState *
1605Py_NewInterpreter(void)
1606{
1607 return _Py_NewInterpreter(0);
1608}
1609
Nick Coghland6009512014-11-20 21:39:37 +10001610/* Delete an interpreter and its last thread. This requires that the
1611 given thread state is current, that the thread has no remaining
1612 frames, and that it is its interpreter's only remaining thread.
1613 It is a fatal error to violate these constraints.
1614
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001615 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001616 everything, regardless.)
1617
1618 Locking: as above.
1619
1620*/
1621
1622void
1623Py_EndInterpreter(PyThreadState *tstate)
1624{
1625 PyInterpreterState *interp = tstate->interp;
1626
Victor Stinnerb45d2592019-06-20 00:05:23 +02001627 if (tstate != _PyThreadState_GET()) {
Victor Stinner9e5d30c2020-03-07 00:54:20 +01001628 Py_FatalError("thread is not current");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001629 }
1630 if (tstate->frame != NULL) {
Victor Stinner9e5d30c2020-03-07 00:54:20 +01001631 Py_FatalError("thread still has a frame");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001632 }
Eric Snow5be45a62019-03-08 22:47:07 -07001633 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001634
Eric Snow842a2f02019-03-15 15:47:51 -06001635 // Wrap up existing "threading"-module-created, non-daemon threads.
Victor Stinnerb45d2592019-06-20 00:05:23 +02001636 wait_for_thread_shutdown(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001637
Victor Stinnerb45d2592019-06-20 00:05:23 +02001638 call_py_exitfuncs(tstate);
Marcel Plch776407f2017-12-20 11:17:58 +01001639
Victor Stinnerb45d2592019-06-20 00:05:23 +02001640 if (tstate != interp->tstate_head || tstate->next != NULL) {
Victor Stinner9e5d30c2020-03-07 00:54:20 +01001641 Py_FatalError("not the last thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001642 }
Nick Coghland6009512014-11-20 21:39:37 +10001643
Victor Stinner987a0dc2019-06-19 10:36:10 +02001644 _PyImport_Cleanup(tstate);
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001645 finalize_interp_clear(tstate);
1646 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001647}
1648
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001649/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001650
Victor Stinner331a6a52019-05-27 16:39:22 +02001651static PyStatus
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001652add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001653{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001654 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001655 m = PyImport_AddModule("__main__");
1656 if (m == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +02001657 return _PyStatus_ERR("can't create __main__ module");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001658
Nick Coghland6009512014-11-20 21:39:37 +10001659 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001660 ann_dict = PyDict_New();
1661 if ((ann_dict == NULL) ||
1662 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001663 return _PyStatus_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001664 }
1665 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001666
Nick Coghland6009512014-11-20 21:39:37 +10001667 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1668 PyObject *bimod = PyImport_ImportModule("builtins");
1669 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001670 return _PyStatus_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001671 }
1672 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001673 return _PyStatus_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001674 }
1675 Py_DECREF(bimod);
1676 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001677
Nick Coghland6009512014-11-20 21:39:37 +10001678 /* Main is a little special - imp.is_builtin("__main__") will return
1679 * False, but BuiltinImporter is still the most appropriate initial
1680 * setting for its __loader__ attribute. A more suitable value will
1681 * be set if __main__ gets further initialized later in the startup
1682 * process.
1683 */
1684 loader = PyDict_GetItemString(d, "__loader__");
1685 if (loader == NULL || loader == Py_None) {
1686 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1687 "BuiltinImporter");
1688 if (loader == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001689 return _PyStatus_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001690 }
1691 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001692 return _PyStatus_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001693 }
1694 Py_DECREF(loader);
1695 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001696 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001697}
1698
Nick Coghland6009512014-11-20 21:39:37 +10001699/* Import the site module (not into __main__ though) */
1700
Victor Stinner331a6a52019-05-27 16:39:22 +02001701static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001702init_import_site(void)
Nick Coghland6009512014-11-20 21:39:37 +10001703{
1704 PyObject *m;
1705 m = PyImport_ImportModule("site");
1706 if (m == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001707 return _PyStatus_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001708 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001709 Py_DECREF(m);
Victor Stinner331a6a52019-05-27 16:39:22 +02001710 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001711}
1712
Victor Stinner874dbe82015-09-04 17:29:57 +02001713/* Check if a file descriptor is valid or not.
1714 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1715static int
1716is_valid_fd(int fd)
1717{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001718/* dup() is faster than fstat(): fstat() can require input/output operations,
1719 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1720 startup. Problem: dup() doesn't check if the file descriptor is valid on
1721 some platforms.
1722
1723 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1724 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1725 EBADF. FreeBSD has similar issue (bpo-32849).
1726
1727 Only use dup() on platforms where dup() is enough to detect invalid FD in
1728 corner cases: on Linux and Windows (bpo-32849). */
1729#if defined(__linux__) || defined(MS_WINDOWS)
1730 if (fd < 0) {
1731 return 0;
1732 }
1733 int fd2;
1734
1735 _Py_BEGIN_SUPPRESS_IPH
1736 fd2 = dup(fd);
1737 if (fd2 >= 0) {
1738 close(fd2);
1739 }
1740 _Py_END_SUPPRESS_IPH
1741
1742 return (fd2 >= 0);
1743#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001744 struct stat st;
1745 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001746#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001747}
1748
1749/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001750static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02001751create_stdio(const PyConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001752 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001753 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001754{
1755 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1756 const char* mode;
1757 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001758 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001759 int buffering, isatty;
1760 _Py_IDENTIFIER(open);
1761 _Py_IDENTIFIER(isatty);
1762 _Py_IDENTIFIER(TextIOWrapper);
1763 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001764 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001765
Victor Stinner874dbe82015-09-04 17:29:57 +02001766 if (!is_valid_fd(fd))
1767 Py_RETURN_NONE;
1768
Nick Coghland6009512014-11-20 21:39:37 +10001769 /* stdin is always opened in buffered mode, first because it shouldn't
1770 make a difference in common use cases, second because TextIOWrapper
1771 depends on the presence of a read1() method which only exists on
1772 buffered streams.
1773 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001774 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001775 buffering = 0;
1776 else
1777 buffering = -1;
1778 if (write_mode)
1779 mode = "wb";
1780 else
1781 mode = "rb";
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001782 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOO",
Nick Coghland6009512014-11-20 21:39:37 +10001783 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001784 Py_None, Py_None, /* encoding, errors */
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001785 Py_None, Py_False); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001786 if (buf == NULL)
1787 goto error;
1788
1789 if (buffering) {
1790 _Py_IDENTIFIER(raw);
1791 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1792 if (raw == NULL)
1793 goto error;
1794 }
1795 else {
1796 raw = buf;
1797 Py_INCREF(raw);
1798 }
1799
Steve Dower39294992016-08-30 21:22:36 -07001800#ifdef MS_WINDOWS
1801 /* Windows console IO is always UTF-8 encoded */
1802 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001803 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001804#endif
1805
Nick Coghland6009512014-11-20 21:39:37 +10001806 text = PyUnicode_FromString(name);
1807 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1808 goto error;
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001809 res = _PyObject_CallMethodIdNoArgs(raw, &PyId_isatty);
Nick Coghland6009512014-11-20 21:39:37 +10001810 if (res == NULL)
1811 goto error;
1812 isatty = PyObject_IsTrue(res);
1813 Py_DECREF(res);
1814 if (isatty == -1)
1815 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001816 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001817 write_through = Py_True;
1818 else
1819 write_through = Py_False;
Jendrik Seipp5b907712020-01-01 23:21:43 +01001820 if (buffered_stdio && (isatty || fd == fileno(stderr)))
Nick Coghland6009512014-11-20 21:39:37 +10001821 line_buffering = Py_True;
1822 else
1823 line_buffering = Py_False;
1824
1825 Py_CLEAR(raw);
1826 Py_CLEAR(text);
1827
1828#ifdef MS_WINDOWS
1829 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1830 newlines to "\n".
1831 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1832 newline = NULL;
1833#else
1834 /* sys.stdin: split lines at "\n".
1835 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1836 newline = "\n";
1837#endif
1838
Victor Stinner709d23d2019-05-02 14:56:30 -04001839 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1840 if (encoding_str == NULL) {
1841 Py_CLEAR(buf);
1842 goto error;
1843 }
1844
1845 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1846 if (errors_str == NULL) {
1847 Py_CLEAR(buf);
1848 Py_CLEAR(encoding_str);
1849 goto error;
1850 }
1851
1852 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1853 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001854 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001855 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001856 Py_CLEAR(encoding_str);
1857 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001858 if (stream == NULL)
1859 goto error;
1860
1861 if (write_mode)
1862 mode = "w";
1863 else
1864 mode = "r";
1865 text = PyUnicode_FromString(mode);
1866 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1867 goto error;
1868 Py_CLEAR(text);
1869 return stream;
1870
1871error:
1872 Py_XDECREF(buf);
1873 Py_XDECREF(stream);
1874 Py_XDECREF(text);
1875 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001876
Victor Stinner874dbe82015-09-04 17:29:57 +02001877 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1878 /* Issue #24891: the file descriptor was closed after the first
1879 is_valid_fd() check was called. Ignore the OSError and set the
1880 stream to None. */
1881 PyErr_Clear();
1882 Py_RETURN_NONE;
1883 }
1884 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001885}
1886
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001887/* Set builtins.open to io.OpenWrapper */
1888static PyStatus
Andy Lester75cd5bf2020-03-12 02:49:05 -05001889init_set_builtins_open(void)
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001890{
1891 PyObject *iomod = NULL, *wrapper;
1892 PyObject *bimod = NULL;
1893 PyStatus res = _PyStatus_OK();
1894
1895 if (!(iomod = PyImport_ImportModule("io"))) {
1896 goto error;
1897 }
1898
1899 if (!(bimod = PyImport_ImportModule("builtins"))) {
1900 goto error;
1901 }
1902
1903 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1904 goto error;
1905 }
1906
1907 /* Set builtins.open */
1908 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1909 Py_DECREF(wrapper);
1910 goto error;
1911 }
1912 Py_DECREF(wrapper);
1913 goto done;
1914
1915error:
1916 res = _PyStatus_ERR("can't initialize io.open");
1917
1918done:
1919 Py_XDECREF(bimod);
1920 Py_XDECREF(iomod);
1921 return res;
1922}
1923
1924
Nick Coghland6009512014-11-20 21:39:37 +10001925/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinner331a6a52019-05-27 16:39:22 +02001926static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001927init_sys_streams(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10001928{
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001929 PyObject *iomod = NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001930 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001931 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001932 PyObject * encoding_attr;
Victor Stinner331a6a52019-05-27 16:39:22 +02001933 PyStatus res = _PyStatus_OK();
Victor Stinnerda7933e2020-04-13 03:04:28 +02001934 const PyConfig *config = _PyInterpreterState_GetConfig(tstate->interp);
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001935
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001936 /* Check that stdin is not a directory
1937 Using shell redirection, you can redirect stdin to a directory,
1938 crashing the Python interpreter. Catch this common mistake here
1939 and output a useful error message. Note that under MS Windows,
1940 the shell already prevents that. */
1941#ifndef MS_WINDOWS
1942 struct _Py_stat_struct sb;
1943 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1944 S_ISDIR(sb.st_mode)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001945 return _PyStatus_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001946 }
1947#endif
1948
Nick Coghland6009512014-11-20 21:39:37 +10001949 if (!(iomod = PyImport_ImportModule("io"))) {
1950 goto error;
1951 }
Nick Coghland6009512014-11-20 21:39:37 +10001952
Nick Coghland6009512014-11-20 21:39:37 +10001953 /* Set sys.stdin */
1954 fd = fileno(stdin);
1955 /* Under some conditions stdin, stdout and stderr may not be connected
1956 * and fileno() may point to an invalid file descriptor. For example
1957 * GUI apps don't have valid standard streams by default.
1958 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001959 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001960 config->stdio_encoding,
1961 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001962 if (std == NULL)
1963 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001964 PySys_SetObject("__stdin__", std);
1965 _PySys_SetObjectId(&PyId_stdin, std);
1966 Py_DECREF(std);
1967
1968 /* Set sys.stdout */
1969 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001970 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001971 config->stdio_encoding,
1972 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001973 if (std == NULL)
1974 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001975 PySys_SetObject("__stdout__", std);
1976 _PySys_SetObjectId(&PyId_stdout, std);
1977 Py_DECREF(std);
1978
1979#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
1980 /* Set sys.stderr, replaces the preliminary stderr */
1981 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001982 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001983 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04001984 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02001985 if (std == NULL)
1986 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001987
1988 /* Same as hack above, pre-import stderr's codec to avoid recursion
1989 when import.c tries to write to stderr in verbose mode. */
1990 encoding_attr = PyObject_GetAttrString(std, "encoding");
1991 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001992 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10001993 if (std_encoding != NULL) {
1994 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
1995 Py_XDECREF(codec_info);
1996 }
1997 Py_DECREF(encoding_attr);
1998 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02001999 _PyErr_Clear(tstate); /* Not a fatal error if codec isn't available */
Nick Coghland6009512014-11-20 21:39:37 +10002000
2001 if (PySys_SetObject("__stderr__", std) < 0) {
2002 Py_DECREF(std);
2003 goto error;
2004 }
2005 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
2006 Py_DECREF(std);
2007 goto error;
2008 }
2009 Py_DECREF(std);
2010#endif
2011
Victor Stinnera7368ac2017-11-15 18:11:45 -08002012 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10002013
Victor Stinnera7368ac2017-11-15 18:11:45 -08002014error:
Victor Stinner331a6a52019-05-27 16:39:22 +02002015 res = _PyStatus_ERR("can't initialize sys standard streams");
Victor Stinnera7368ac2017-11-15 18:11:45 -08002016
2017done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02002018 _Py_ClearStandardStreamEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10002019 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08002020 return res;
Nick Coghland6009512014-11-20 21:39:37 +10002021}
2022
2023
Victor Stinner10dc4842015-03-24 12:01:30 +01002024static void
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002025_Py_FatalError_DumpTracebacks(int fd, PyInterpreterState *interp,
2026 PyThreadState *tstate)
Victor Stinner10dc4842015-03-24 12:01:30 +01002027{
Victor Stinner10dc4842015-03-24 12:01:30 +01002028 fputc('\n', stderr);
2029 fflush(stderr);
2030
2031 /* display the current Python stack */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002032 _Py_DumpTracebackThreads(fd, interp, tstate);
Victor Stinner10dc4842015-03-24 12:01:30 +01002033}
Victor Stinner791da1c2016-03-14 16:53:12 +01002034
2035/* Print the current exception (if an exception is set) with its traceback,
2036 or display the current Python stack.
2037
2038 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
2039 called on catastrophic cases.
2040
2041 Return 1 if the traceback was displayed, 0 otherwise. */
2042
2043static int
Andy Lester75cd5bf2020-03-12 02:49:05 -05002044_Py_FatalError_PrintExc(PyThreadState *tstate)
Victor Stinner791da1c2016-03-14 16:53:12 +01002045{
2046 PyObject *ferr, *res;
2047 PyObject *exception, *v, *tb;
2048 int has_tb;
2049
Victor Stinnerb45d2592019-06-20 00:05:23 +02002050 _PyErr_Fetch(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002051 if (exception == NULL) {
2052 /* No current exception */
2053 return 0;
2054 }
2055
2056 ferr = _PySys_GetObjectId(&PyId_stderr);
2057 if (ferr == NULL || ferr == Py_None) {
2058 /* sys.stderr is not set yet or set to None,
2059 no need to try to display the exception */
2060 return 0;
2061 }
2062
Victor Stinnerb45d2592019-06-20 00:05:23 +02002063 _PyErr_NormalizeException(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002064 if (tb == NULL) {
2065 tb = Py_None;
2066 Py_INCREF(tb);
2067 }
2068 PyException_SetTraceback(v, tb);
2069 if (exception == NULL) {
2070 /* PyErr_NormalizeException() failed */
2071 return 0;
2072 }
2073
2074 has_tb = (tb != Py_None);
2075 PyErr_Display(exception, v, tb);
2076 Py_XDECREF(exception);
2077 Py_XDECREF(v);
2078 Py_XDECREF(tb);
2079
2080 /* sys.stderr may be buffered: call sys.stderr.flush() */
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002081 res = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002082 if (res == NULL) {
2083 _PyErr_Clear(tstate);
2084 }
2085 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002086 Py_DECREF(res);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002087 }
Victor Stinner791da1c2016-03-14 16:53:12 +01002088
2089 return has_tb;
2090}
2091
Nick Coghland6009512014-11-20 21:39:37 +10002092/* Print fatal error message and abort */
2093
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002094#ifdef MS_WINDOWS
2095static void
2096fatal_output_debug(const char *msg)
2097{
2098 /* buffer of 256 bytes allocated on the stack */
2099 WCHAR buffer[256 / sizeof(WCHAR)];
2100 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2101 size_t msglen;
2102
2103 OutputDebugStringW(L"Fatal Python error: ");
2104
2105 msglen = strlen(msg);
2106 while (msglen) {
2107 size_t i;
2108
2109 if (buflen > msglen) {
2110 buflen = msglen;
2111 }
2112
2113 /* Convert the message to wchar_t. This uses a simple one-to-one
2114 conversion, assuming that the this error message actually uses
2115 ASCII only. If this ceases to be true, we will have to convert. */
2116 for (i=0; i < buflen; ++i) {
2117 buffer[i] = msg[i];
2118 }
2119 buffer[i] = L'\0';
2120 OutputDebugStringW(buffer);
2121
2122 msg += buflen;
2123 msglen -= buflen;
2124 }
2125 OutputDebugStringW(L"\n");
2126}
2127#endif
2128
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002129
2130static void
2131fatal_error_dump_runtime(FILE *stream, _PyRuntimeState *runtime)
2132{
2133 fprintf(stream, "Python runtime state: ");
Victor Stinner7b3c2522020-03-07 00:24:23 +01002134 PyThreadState *finalizing = _PyRuntimeState_GetFinalizing(runtime);
2135 if (finalizing) {
2136 fprintf(stream, "finalizing (tstate=%p)", finalizing);
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002137 }
2138 else if (runtime->initialized) {
2139 fprintf(stream, "initialized");
2140 }
2141 else if (runtime->core_initialized) {
2142 fprintf(stream, "core initialized");
2143 }
2144 else if (runtime->preinitialized) {
2145 fprintf(stream, "preinitialized");
2146 }
2147 else if (runtime->preinitializing) {
2148 fprintf(stream, "preinitializing");
2149 }
2150 else {
2151 fprintf(stream, "unknown");
2152 }
2153 fprintf(stream, "\n");
2154 fflush(stream);
2155}
2156
2157
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002158static inline void _Py_NO_RETURN
2159fatal_error_exit(int status)
Nick Coghland6009512014-11-20 21:39:37 +10002160{
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002161 if (status < 0) {
2162#if defined(MS_WINDOWS) && defined(_DEBUG)
2163 DebugBreak();
2164#endif
2165 abort();
2166 }
2167 else {
2168 exit(status);
2169 }
2170}
2171
2172
2173static void _Py_NO_RETURN
2174fatal_error(FILE *stream, int header, const char *prefix, const char *msg,
2175 int status)
2176{
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002177 const int fd = fileno(stream);
Victor Stinner53345a42015-03-25 01:55:14 +01002178 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002179
2180 if (reentrant) {
2181 /* Py_FatalError() caused a second fatal error.
2182 Example: flush_std_files() raises a recursion error. */
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002183 fatal_error_exit(status);
Victor Stinner53345a42015-03-25 01:55:14 +01002184 }
2185 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002186
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002187 if (header) {
2188 fprintf(stream, "Fatal Python error: ");
2189 if (prefix) {
2190 fputs(prefix, stream);
2191 fputs(": ", stream);
2192 }
2193 if (msg) {
2194 fputs(msg, stream);
2195 }
2196 else {
2197 fprintf(stream, "<message not set>");
2198 }
2199 fputs("\n", stream);
2200 fflush(stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002201 }
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002202
2203 _PyRuntimeState *runtime = &_PyRuntime;
2204 fatal_error_dump_runtime(stream, runtime);
2205
2206 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
2207 PyInterpreterState *interp = NULL;
2208 if (tstate != NULL) {
2209 interp = tstate->interp;
2210 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002211
Victor Stinner3a228ab2018-11-01 00:26:41 +01002212 /* Check if the current thread has a Python thread state
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002213 and holds the GIL.
Victor Stinner3a228ab2018-11-01 00:26:41 +01002214
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002215 tss_tstate is NULL if Py_FatalError() is called from a C thread which
2216 has no Python thread state.
2217
2218 tss_tstate != tstate if the current Python thread does not hold the GIL.
2219 */
2220 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2221 int has_tstate_and_gil = (tss_tstate != NULL && tss_tstate == tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002222 if (has_tstate_and_gil) {
2223 /* If an exception is set, print the exception with its traceback */
Andy Lester75cd5bf2020-03-12 02:49:05 -05002224 if (!_Py_FatalError_PrintExc(tss_tstate)) {
Victor Stinner3a228ab2018-11-01 00:26:41 +01002225 /* No exception is set, or an exception is set without traceback */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002226 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002227 }
2228 }
2229 else {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002230 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002231 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002232
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002233 /* The main purpose of faulthandler is to display the traceback.
2234 This function already did its best to display a traceback.
2235 Disable faulthandler to prevent writing a second traceback
2236 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002237 _PyFaulthandler_Fini();
2238
Victor Stinner791da1c2016-03-14 16:53:12 +01002239 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002240 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002241 /* Flush sys.stdout and sys.stderr */
2242 flush_std_files();
2243 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002244
Nick Coghland6009512014-11-20 21:39:37 +10002245#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002246 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002247#endif /* MS_WINDOWS */
2248
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002249 fatal_error_exit(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002250}
2251
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002252
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002253#undef Py_FatalError
2254
Victor Stinner19760862017-12-20 01:41:59 +01002255void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002256Py_FatalError(const char *msg)
2257{
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002258 fatal_error(stderr, 1, NULL, msg, -1);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002259}
2260
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002261
Victor Stinner19760862017-12-20 01:41:59 +01002262void _Py_NO_RETURN
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002263_Py_FatalErrorFunc(const char *func, const char *msg)
2264{
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002265 fatal_error(stderr, 1, func, msg, -1);
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002266}
2267
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002268
2269void _Py_NO_RETURN
2270_Py_FatalErrorFormat(const char *func, const char *format, ...)
2271{
2272 static int reentrant = 0;
2273 if (reentrant) {
2274 /* _Py_FatalErrorFormat() caused a second fatal error */
2275 fatal_error_exit(-1);
2276 }
2277 reentrant = 1;
2278
2279 FILE *stream = stderr;
2280 fprintf(stream, "Fatal Python error: ");
2281 if (func) {
2282 fputs(func, stream);
2283 fputs(": ", stream);
2284 }
2285 fflush(stream);
2286
2287 va_list vargs;
2288#ifdef HAVE_STDARG_PROTOTYPES
2289 va_start(vargs, format);
2290#else
2291 va_start(vargs);
2292#endif
2293 vfprintf(stream, format, vargs);
2294 va_end(vargs);
2295
2296 fputs("\n", stream);
2297 fflush(stream);
2298
2299 fatal_error(stream, 0, NULL, NULL, -1);
2300}
2301
2302
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002303void _Py_NO_RETURN
Victor Stinner331a6a52019-05-27 16:39:22 +02002304Py_ExitStatusException(PyStatus status)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002305{
Victor Stinner331a6a52019-05-27 16:39:22 +02002306 if (_PyStatus_IS_EXIT(status)) {
2307 exit(status.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002308 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002309 else if (_PyStatus_IS_ERROR(status)) {
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002310 fatal_error(stderr, 1, status.func, status.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002311 }
2312 else {
Victor Stinner331a6a52019-05-27 16:39:22 +02002313 Py_FatalError("Py_ExitStatusException() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002314 }
Nick Coghland6009512014-11-20 21:39:37 +10002315}
2316
2317/* Clean up and exit */
2318
Nick Coghland6009512014-11-20 21:39:37 +10002319/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002320void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002321{
Victor Stinner81a7be32020-04-14 15:14:01 +02002322 PyInterpreterState *is = _PyInterpreterState_GET();
Marcel Plch776407f2017-12-20 11:17:58 +01002323
Antoine Pitroufc5db952017-12-13 02:29:07 +01002324 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002325 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2326
2327 is->pyexitfunc = func;
2328 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002329}
2330
2331static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002332call_py_exitfuncs(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002333{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002334 PyInterpreterState *interp = tstate->interp;
2335 if (interp->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002336 return;
2337
Victor Stinnerb45d2592019-06-20 00:05:23 +02002338 (*interp->pyexitfunc)(interp->pyexitmodule);
2339 _PyErr_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10002340}
2341
2342/* Wait until threading._shutdown completes, provided
2343 the threading module was imported in the first place.
2344 The shutdown routine will wait until all non-daemon
2345 "threading" threads have completed. */
2346static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002347wait_for_thread_shutdown(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002348{
Nick Coghland6009512014-11-20 21:39:37 +10002349 _Py_IDENTIFIER(_shutdown);
2350 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002351 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002352 if (threading == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +02002353 if (_PyErr_Occurred(tstate)) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002354 PyErr_WriteUnraisable(NULL);
2355 }
2356 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002357 return;
2358 }
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002359 result = _PyObject_CallMethodIdNoArgs(threading, &PyId__shutdown);
Nick Coghland6009512014-11-20 21:39:37 +10002360 if (result == NULL) {
2361 PyErr_WriteUnraisable(threading);
2362 }
2363 else {
2364 Py_DECREF(result);
2365 }
2366 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002367}
2368
2369#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002370int Py_AtExit(void (*func)(void))
2371{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002372 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002373 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002374 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002375 return 0;
2376}
2377
2378static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002379call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002380{
Victor Stinner8e91c242019-04-24 17:24:01 +02002381 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002382 /* pop last function from the list */
2383 runtime->nexitfuncs--;
2384 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2385 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2386
2387 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002388 }
Nick Coghland6009512014-11-20 21:39:37 +10002389
2390 fflush(stdout);
2391 fflush(stderr);
2392}
2393
Victor Stinnercfc88312018-08-01 16:41:25 +02002394void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002395Py_Exit(int sts)
2396{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002397 if (Py_FinalizeEx() < 0) {
2398 sts = 120;
2399 }
Nick Coghland6009512014-11-20 21:39:37 +10002400
2401 exit(sts);
2402}
2403
Victor Stinner331a6a52019-05-27 16:39:22 +02002404static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02002405init_signals(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002406{
2407#ifdef SIGPIPE
2408 PyOS_setsig(SIGPIPE, SIG_IGN);
2409#endif
2410#ifdef SIGXFZ
2411 PyOS_setsig(SIGXFZ, SIG_IGN);
2412#endif
2413#ifdef SIGXFSZ
2414 PyOS_setsig(SIGXFSZ, SIG_IGN);
2415#endif
Victor Stinner400e1db2020-03-31 19:13:10 +02002416 PyOS_InitInterrupts(); /* May imply init_signals() */
Victor Stinnerb45d2592019-06-20 00:05:23 +02002417 if (_PyErr_Occurred(tstate)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002418 return _PyStatus_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002419 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002420 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002421}
2422
2423
2424/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2425 *
2426 * All of the code in this function must only use async-signal-safe functions,
2427 * listed at `man 7 signal` or
2428 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
Victor Stinnerefc28bb2020-03-05 18:13:56 +01002429 *
2430 * If this function is updated, update also _posix_spawn() of subprocess.py.
Nick Coghland6009512014-11-20 21:39:37 +10002431 */
2432void
2433_Py_RestoreSignals(void)
2434{
2435#ifdef SIGPIPE
2436 PyOS_setsig(SIGPIPE, SIG_DFL);
2437#endif
2438#ifdef SIGXFZ
2439 PyOS_setsig(SIGXFZ, SIG_DFL);
2440#endif
2441#ifdef SIGXFSZ
2442 PyOS_setsig(SIGXFSZ, SIG_DFL);
2443#endif
2444}
2445
2446
2447/*
2448 * The file descriptor fd is considered ``interactive'' if either
2449 * a) isatty(fd) is TRUE, or
2450 * b) the -i flag was given, and the filename associated with
2451 * the descriptor is NULL or "<stdin>" or "???".
2452 */
2453int
2454Py_FdIsInteractive(FILE *fp, const char *filename)
2455{
2456 if (isatty((int)fileno(fp)))
2457 return 1;
2458 if (!Py_InteractiveFlag)
2459 return 0;
2460 return (filename == NULL) ||
2461 (strcmp(filename, "<stdin>") == 0) ||
2462 (strcmp(filename, "???") == 0);
2463}
2464
2465
Nick Coghland6009512014-11-20 21:39:37 +10002466/* Wrappers around sigaction() or signal(). */
2467
2468PyOS_sighandler_t
2469PyOS_getsig(int sig)
2470{
2471#ifdef HAVE_SIGACTION
2472 struct sigaction context;
2473 if (sigaction(sig, NULL, &context) == -1)
2474 return SIG_ERR;
2475 return context.sa_handler;
2476#else
2477 PyOS_sighandler_t handler;
2478/* Special signal handling for the secure CRT in Visual Studio 2005 */
2479#if defined(_MSC_VER) && _MSC_VER >= 1400
2480 switch (sig) {
2481 /* Only these signals are valid */
2482 case SIGINT:
2483 case SIGILL:
2484 case SIGFPE:
2485 case SIGSEGV:
2486 case SIGTERM:
2487 case SIGBREAK:
2488 case SIGABRT:
2489 break;
2490 /* Don't call signal() with other values or it will assert */
2491 default:
2492 return SIG_ERR;
2493 }
2494#endif /* _MSC_VER && _MSC_VER >= 1400 */
2495 handler = signal(sig, SIG_IGN);
2496 if (handler != SIG_ERR)
2497 signal(sig, handler);
2498 return handler;
2499#endif
2500}
2501
2502/*
2503 * All of the code in this function must only use async-signal-safe functions,
2504 * listed at `man 7 signal` or
2505 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2506 */
2507PyOS_sighandler_t
2508PyOS_setsig(int sig, PyOS_sighandler_t handler)
2509{
2510#ifdef HAVE_SIGACTION
2511 /* Some code in Modules/signalmodule.c depends on sigaction() being
2512 * used here if HAVE_SIGACTION is defined. Fix that if this code
2513 * changes to invalidate that assumption.
2514 */
2515 struct sigaction context, ocontext;
2516 context.sa_handler = handler;
2517 sigemptyset(&context.sa_mask);
2518 context.sa_flags = 0;
2519 if (sigaction(sig, &context, &ocontext) == -1)
2520 return SIG_ERR;
2521 return ocontext.sa_handler;
2522#else
2523 PyOS_sighandler_t oldhandler;
2524 oldhandler = signal(sig, handler);
2525#ifdef HAVE_SIGINTERRUPT
2526 siginterrupt(sig, 1);
2527#endif
2528 return oldhandler;
2529#endif
2530}
2531
2532#ifdef __cplusplus
2533}
2534#endif