blob: cfb3a7d941710f9fa9f0bf6c5371e0278b793aff [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
21#include "grammar.h" // PyGrammar_RemoveAccelerators()
22#include <locale.h> // setlocale()
Nick Coghland6009512014-11-20 21:39:37 +100023
24#ifdef HAVE_SIGNAL_H
Victor Stinner4f98f462020-04-15 04:01:58 +020025# include <signal.h> // SIG_IGN
Nick Coghland6009512014-11-20 21:39:37 +100026#endif
27
28#ifdef HAVE_LANGINFO_H
Victor Stinner4f98f462020-04-15 04:01:58 +020029# include <langinfo.h> // nl_langinfo(CODESET)
Nick Coghland6009512014-11-20 21:39:37 +100030#endif
31
32#ifdef MS_WINDOWS
Victor Stinner4f98f462020-04-15 04:01:58 +020033# undef BYTE
34# include "windows.h"
Steve Dower39294992016-08-30 21:22:36 -070035
Victor Stinner4f98f462020-04-15 04:01:58 +020036 extern PyTypeObject PyWindowsConsoleIO_Type;
37# define PyWindowsConsoleIO_Check(op) \
38 (PyObject_TypeCheck((op), &PyWindowsConsoleIO_Type))
Nick Coghland6009512014-11-20 21:39:37 +100039#endif
40
Victor Stinner4f98f462020-04-15 04:01:58 +020041
Nick Coghland6009512014-11-20 21:39:37 +100042_Py_IDENTIFIER(flush);
43_Py_IDENTIFIER(name);
44_Py_IDENTIFIER(stdin);
45_Py_IDENTIFIER(stdout);
46_Py_IDENTIFIER(stderr);
Eric Snow3f9eee62017-09-15 16:35:20 -060047_Py_IDENTIFIER(threading);
Nick Coghland6009512014-11-20 21:39:37 +100048
49#ifdef __cplusplus
50extern "C" {
51#endif
52
Nick Coghland6009512014-11-20 21:39:37 +100053extern grammar _PyParser_Grammar; /* From graminit.c */
54
Victor Stinnerb45d2592019-06-20 00:05:23 +020055/* Forward declarations */
Victor Stinner331a6a52019-05-27 16:39:22 +020056static PyStatus add_main_module(PyInterpreterState *interp);
Victor Stinnerb45d2592019-06-20 00:05:23 +020057static PyStatus init_import_site(void);
Andy Lester75cd5bf2020-03-12 02:49:05 -050058static PyStatus init_set_builtins_open(void);
Victor Stinnerb45d2592019-06-20 00:05:23 +020059static PyStatus init_sys_streams(PyThreadState *tstate);
60static PyStatus init_signals(PyThreadState *tstate);
61static void call_py_exitfuncs(PyThreadState *tstate);
62static void wait_for_thread_shutdown(PyThreadState *tstate);
Victor Stinner8e91c242019-04-24 17:24:01 +020063static void call_ll_exitfuncs(_PyRuntimeState *runtime);
Nick Coghland6009512014-11-20 21:39:37 +100064
Gregory P. Smith38f11cc2019-02-16 12:57:40 -080065int _Py_UnhandledKeyboardInterrupt = 0;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080066_PyRuntimeState _PyRuntime = _PyRuntimeState_INIT;
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010067static int runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060068
Victor Stinner331a6a52019-05-27 16:39:22 +020069PyStatus
Eric Snow2ebc5ce2017-09-07 23:51:28 -060070_PyRuntime_Initialize(void)
71{
72 /* XXX We only initialize once in the process, which aligns with
73 the static initialization of the former globals now found in
74 _PyRuntime. However, _PyRuntime *should* be initialized with
75 every Py_Initialize() call, but doing so breaks the runtime.
76 This is because the runtime state is not properly finalized
77 currently. */
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010078 if (runtime_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +020079 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -080080 }
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010081 runtime_initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080082
83 return _PyRuntimeState_Init(&_PyRuntime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -060084}
85
86void
87_PyRuntime_Finalize(void)
88{
89 _PyRuntimeState_Fini(&_PyRuntime);
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010090 runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060091}
92
93int
94_Py_IsFinalizing(void)
95{
Victor Stinner7b3c2522020-03-07 00:24:23 +010096 return _PyRuntimeState_GetFinalizing(&_PyRuntime) != NULL;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060097}
98
Nick Coghland6009512014-11-20 21:39:37 +100099/* Hack to force loading of object files */
100int (*_PyOS_mystrnicmp_hack)(const char *, const char *, Py_ssize_t) = \
101 PyOS_mystrnicmp; /* Python/pystrcmp.o */
102
103/* PyModule_GetWarningsModule is no longer necessary as of 2.6
104since _warnings is builtin. This API should not be used. */
105PyObject *
106PyModule_GetWarningsModule(void)
107{
108 return PyImport_ImportModule("warnings");
109}
110
Eric Snowc7ec9982017-05-23 23:00:52 -0700111
Eric Snow1abcf672017-05-23 21:46:51 -0700112/* APIs to access the initialization flags
113 *
114 * Can be called prior to Py_Initialize.
115 */
Nick Coghland6009512014-11-20 21:39:37 +1000116
Eric Snow1abcf672017-05-23 21:46:51 -0700117int
118_Py_IsCoreInitialized(void)
119{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600120 return _PyRuntime.core_initialized;
Eric Snow1abcf672017-05-23 21:46:51 -0700121}
Nick Coghland6009512014-11-20 21:39:37 +1000122
123int
124Py_IsInitialized(void)
125{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600126 return _PyRuntime.initialized;
Nick Coghland6009512014-11-20 21:39:37 +1000127}
128
Nick Coghlan6ea41862017-06-11 13:16:15 +1000129
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000130/* Global initializations. Can be undone by Py_FinalizeEx(). Don't
131 call this twice without an intervening Py_FinalizeEx() call. When
Nick Coghland6009512014-11-20 21:39:37 +1000132 initializations fail, a fatal error is issued and the function does
133 not return. On return, the first thread and interpreter state have
134 been created.
135
136 Locking: you must hold the interpreter lock while calling this.
137 (If the lock has not yet been initialized, that's equivalent to
138 having the lock, but you cannot use multiple threads.)
139
140*/
141
Victor Stinner331a6a52019-05-27 16:39:22 +0200142static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200143init_importlib(PyThreadState *tstate, PyObject *sysmod)
Nick Coghland6009512014-11-20 21:39:37 +1000144{
145 PyObject *importlib;
146 PyObject *impmod;
Nick Coghland6009512014-11-20 21:39:37 +1000147 PyObject *value;
Victor Stinnerb45d2592019-06-20 00:05:23 +0200148 PyInterpreterState *interp = tstate->interp;
Victor Stinnerda7933e2020-04-13 03:04:28 +0200149 int verbose = _PyInterpreterState_GetConfig(interp)->verbose;
Nick Coghland6009512014-11-20 21:39:37 +1000150
151 /* Import _importlib through its frozen version, _frozen_importlib. */
152 if (PyImport_ImportFrozenModule("_frozen_importlib") <= 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200153 return _PyStatus_ERR("can't import _frozen_importlib");
Nick Coghland6009512014-11-20 21:39:37 +1000154 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200155 else if (verbose) {
Nick Coghland6009512014-11-20 21:39:37 +1000156 PySys_FormatStderr("import _frozen_importlib # frozen\n");
157 }
158 importlib = PyImport_AddModule("_frozen_importlib");
159 if (importlib == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200160 return _PyStatus_ERR("couldn't get _frozen_importlib from sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000161 }
162 interp->importlib = importlib;
163 Py_INCREF(interp->importlib);
164
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300165 interp->import_func = PyDict_GetItemString(interp->builtins, "__import__");
166 if (interp->import_func == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +0200167 return _PyStatus_ERR("__import__ not found");
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300168 Py_INCREF(interp->import_func);
169
Victor Stinnercd6e6942015-09-18 09:11:57 +0200170 /* Import the _imp module */
Benjamin Petersonc65ef772018-01-29 11:33:57 -0800171 impmod = PyInit__imp();
Nick Coghland6009512014-11-20 21:39:37 +1000172 if (impmod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200173 return _PyStatus_ERR("can't import _imp");
Nick Coghland6009512014-11-20 21:39:37 +1000174 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200175 else if (verbose) {
Victor Stinnercd6e6942015-09-18 09:11:57 +0200176 PySys_FormatStderr("import _imp # builtin\n");
Nick Coghland6009512014-11-20 21:39:37 +1000177 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600178 if (_PyImport_SetModuleString("_imp", impmod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200179 return _PyStatus_ERR("can't save _imp to sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000180 }
181
Victor Stinnercd6e6942015-09-18 09:11:57 +0200182 /* Install importlib as the implementation of import */
Nick Coghland6009512014-11-20 21:39:37 +1000183 value = PyObject_CallMethod(importlib, "_install", "OO", sysmod, impmod);
184 if (value == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200185 _PyErr_Print(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200186 return _PyStatus_ERR("importlib install failed");
Nick Coghland6009512014-11-20 21:39:37 +1000187 }
188 Py_DECREF(value);
189 Py_DECREF(impmod);
190
Victor Stinner331a6a52019-05-27 16:39:22 +0200191 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000192}
193
Victor Stinner331a6a52019-05-27 16:39:22 +0200194static PyStatus
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200195init_importlib_external(PyThreadState *tstate)
Eric Snow1abcf672017-05-23 21:46:51 -0700196{
197 PyObject *value;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200198 value = PyObject_CallMethod(tstate->interp->importlib,
Eric Snow1abcf672017-05-23 21:46:51 -0700199 "_install_external_importers", "");
200 if (value == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200201 _PyErr_Print(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200202 return _PyStatus_ERR("external importer setup failed");
Eric Snow1abcf672017-05-23 21:46:51 -0700203 }
Stéphane Wirtelab1cb802017-06-08 13:13:20 +0200204 Py_DECREF(value);
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200205 return _PyImportZip_Init(tstate);
Eric Snow1abcf672017-05-23 21:46:51 -0700206}
Nick Coghland6009512014-11-20 21:39:37 +1000207
Nick Coghlan6ea41862017-06-11 13:16:15 +1000208/* Helper functions to better handle the legacy C locale
209 *
210 * The legacy C locale assumes ASCII as the default text encoding, which
211 * causes problems not only for the CPython runtime, but also other
212 * components like GNU readline.
213 *
214 * Accordingly, when the CLI detects it, it attempts to coerce it to a
215 * more capable UTF-8 based alternative as follows:
216 *
217 * if (_Py_LegacyLocaleDetected()) {
218 * _Py_CoerceLegacyLocale();
219 * }
220 *
221 * See the documentation of the PYTHONCOERCECLOCALE setting for more details.
222 *
223 * Locale coercion also impacts the default error handler for the standard
224 * streams: while the usual default is "strict", the default for the legacy
225 * C locale and for any of the coercion target locales is "surrogateescape".
226 */
227
228int
Victor Stinner0f721472019-05-20 17:16:38 +0200229_Py_LegacyLocaleDetected(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000230{
231#ifndef MS_WINDOWS
Victor Stinner0f721472019-05-20 17:16:38 +0200232 if (!warn) {
233 const char *locale_override = getenv("LC_ALL");
234 if (locale_override != NULL && *locale_override != '\0') {
235 /* Don't coerce C locale if the LC_ALL environment variable
236 is set */
237 return 0;
238 }
239 }
240
Nick Coghlan6ea41862017-06-11 13:16:15 +1000241 /* On non-Windows systems, the C locale is considered a legacy locale */
Nick Coghlaneb817952017-06-18 12:29:42 +1000242 /* XXX (ncoghlan): some platforms (notably Mac OS X) don't appear to treat
243 * the POSIX locale as a simple alias for the C locale, so
244 * we may also want to check for that explicitly.
245 */
Nick Coghlan6ea41862017-06-11 13:16:15 +1000246 const char *ctype_loc = setlocale(LC_CTYPE, NULL);
247 return ctype_loc != NULL && strcmp(ctype_loc, "C") == 0;
248#else
249 /* Windows uses code pages instead of locales, so no locale is legacy */
250 return 0;
251#endif
252}
253
Victor Stinnerb0051362019-11-22 17:52:42 +0100254#ifndef MS_WINDOWS
Nick Coghlaneb817952017-06-18 12:29:42 +1000255static const char *_C_LOCALE_WARNING =
256 "Python runtime initialized with LC_CTYPE=C (a locale with default ASCII "
257 "encoding), which may cause Unicode compatibility problems. Using C.UTF-8, "
258 "C.utf8, or UTF-8 (if available) as alternative Unicode-compatible "
259 "locales is recommended.\n";
260
Nick Coghlaneb817952017-06-18 12:29:42 +1000261static void
Victor Stinner43125222019-04-24 18:23:53 +0200262emit_stderr_warning_for_legacy_locale(_PyRuntimeState *runtime)
Nick Coghlaneb817952017-06-18 12:29:42 +1000263{
Victor Stinner331a6a52019-05-27 16:39:22 +0200264 const PyPreConfig *preconfig = &runtime->preconfig;
Victor Stinner0f721472019-05-20 17:16:38 +0200265 if (preconfig->coerce_c_locale_warn && _Py_LegacyLocaleDetected(1)) {
Victor Stinnercf215042018-08-29 22:56:06 +0200266 PySys_FormatStderr("%s", _C_LOCALE_WARNING);
Nick Coghlaneb817952017-06-18 12:29:42 +1000267 }
268}
Victor Stinnerb0051362019-11-22 17:52:42 +0100269#endif /* !defined(MS_WINDOWS) */
Nick Coghlaneb817952017-06-18 12:29:42 +1000270
Nick Coghlan6ea41862017-06-11 13:16:15 +1000271typedef struct _CandidateLocale {
272 const char *locale_name; /* The locale to try as a coercion target */
273} _LocaleCoercionTarget;
274
275static _LocaleCoercionTarget _TARGET_LOCALES[] = {
276 {"C.UTF-8"},
277 {"C.utf8"},
Nick Coghlan18974c32017-06-30 00:48:14 +1000278 {"UTF-8"},
Nick Coghlan6ea41862017-06-11 13:16:15 +1000279 {NULL}
280};
281
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200282
283int
284_Py_IsLocaleCoercionTarget(const char *ctype_loc)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000285{
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200286 const _LocaleCoercionTarget *target = NULL;
287 for (target = _TARGET_LOCALES; target->locale_name; target++) {
288 if (strcmp(ctype_loc, target->locale_name) == 0) {
289 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000290 }
Victor Stinner124b9eb2018-08-29 01:29:06 +0200291 }
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200292 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000293}
294
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200295
Nick Coghlan6ea41862017-06-11 13:16:15 +1000296#ifdef PY_COERCE_C_LOCALE
Victor Stinner94540602017-12-16 04:54:22 +0100297static const char C_LOCALE_COERCION_WARNING[] =
Nick Coghlan6ea41862017-06-11 13:16:15 +1000298 "Python detected LC_CTYPE=C: LC_CTYPE coerced to %.20s (set another locale "
299 "or PYTHONCOERCECLOCALE=0 to disable this locale coercion behavior).\n";
300
Victor Stinner0f721472019-05-20 17:16:38 +0200301static int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200302_coerce_default_locale_settings(int warn, const _LocaleCoercionTarget *target)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000303{
304 const char *newloc = target->locale_name;
305
306 /* Reset locale back to currently configured defaults */
xdegaye1588be62017-11-12 12:45:59 +0100307 _Py_SetLocaleFromEnv(LC_ALL);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000308
309 /* Set the relevant locale environment variable */
310 if (setenv("LC_CTYPE", newloc, 1)) {
311 fprintf(stderr,
312 "Error setting LC_CTYPE, skipping C locale coercion\n");
Victor Stinner0f721472019-05-20 17:16:38 +0200313 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000314 }
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200315 if (warn) {
Victor Stinner94540602017-12-16 04:54:22 +0100316 fprintf(stderr, C_LOCALE_COERCION_WARNING, newloc);
Nick Coghlaneb817952017-06-18 12:29:42 +1000317 }
Nick Coghlan6ea41862017-06-11 13:16:15 +1000318
319 /* Reconfigure with the overridden environment variables */
xdegaye1588be62017-11-12 12:45:59 +0100320 _Py_SetLocaleFromEnv(LC_ALL);
Victor Stinner0f721472019-05-20 17:16:38 +0200321 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000322}
323#endif
324
Victor Stinner0f721472019-05-20 17:16:38 +0200325int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200326_Py_CoerceLegacyLocale(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000327{
Victor Stinner0f721472019-05-20 17:16:38 +0200328 int coerced = 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000329#ifdef PY_COERCE_C_LOCALE
Victor Stinner8ea09112018-09-03 17:05:18 +0200330 char *oldloc = NULL;
331
332 oldloc = _PyMem_RawStrdup(setlocale(LC_CTYPE, NULL));
333 if (oldloc == NULL) {
Victor Stinner0f721472019-05-20 17:16:38 +0200334 return coerced;
Victor Stinner8ea09112018-09-03 17:05:18 +0200335 }
336
Victor Stinner94540602017-12-16 04:54:22 +0100337 const char *locale_override = getenv("LC_ALL");
338 if (locale_override == NULL || *locale_override == '\0') {
339 /* LC_ALL is also not set (or is set to an empty string) */
340 const _LocaleCoercionTarget *target = NULL;
341 for (target = _TARGET_LOCALES; target->locale_name; target++) {
342 const char *new_locale = setlocale(LC_CTYPE,
343 target->locale_name);
344 if (new_locale != NULL) {
Victor Stinnere2510952019-05-02 11:28:57 -0400345#if !defined(_Py_FORCE_UTF8_LOCALE) && defined(HAVE_LANGINFO_H) && defined(CODESET)
Victor Stinner94540602017-12-16 04:54:22 +0100346 /* Also ensure that nl_langinfo works in this locale */
347 char *codeset = nl_langinfo(CODESET);
348 if (!codeset || *codeset == '\0') {
349 /* CODESET is not set or empty, so skip coercion */
350 new_locale = NULL;
351 _Py_SetLocaleFromEnv(LC_CTYPE);
352 continue;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000353 }
Victor Stinner94540602017-12-16 04:54:22 +0100354#endif
355 /* Successfully configured locale, so make it the default */
Victor Stinner0f721472019-05-20 17:16:38 +0200356 coerced = _coerce_default_locale_settings(warn, target);
Victor Stinner8ea09112018-09-03 17:05:18 +0200357 goto done;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000358 }
359 }
360 }
361 /* No C locale warning here, as Py_Initialize will emit one later */
Victor Stinner8ea09112018-09-03 17:05:18 +0200362
363 setlocale(LC_CTYPE, oldloc);
364
365done:
366 PyMem_RawFree(oldloc);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000367#endif
Victor Stinner0f721472019-05-20 17:16:38 +0200368 return coerced;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000369}
370
xdegaye1588be62017-11-12 12:45:59 +0100371/* _Py_SetLocaleFromEnv() is a wrapper around setlocale(category, "") to
372 * isolate the idiosyncrasies of different libc implementations. It reads the
373 * appropriate environment variable and uses its value to select the locale for
374 * 'category'. */
375char *
376_Py_SetLocaleFromEnv(int category)
377{
Victor Stinner353933e2018-11-23 13:08:26 +0100378 char *res;
xdegaye1588be62017-11-12 12:45:59 +0100379#ifdef __ANDROID__
380 const char *locale;
381 const char **pvar;
382#ifdef PY_COERCE_C_LOCALE
383 const char *coerce_c_locale;
384#endif
385 const char *utf8_locale = "C.UTF-8";
386 const char *env_var_set[] = {
387 "LC_ALL",
388 "LC_CTYPE",
389 "LANG",
390 NULL,
391 };
392
393 /* Android setlocale(category, "") doesn't check the environment variables
394 * and incorrectly sets the "C" locale at API 24 and older APIs. We only
395 * check the environment variables listed in env_var_set. */
396 for (pvar=env_var_set; *pvar; pvar++) {
397 locale = getenv(*pvar);
398 if (locale != NULL && *locale != '\0') {
399 if (strcmp(locale, utf8_locale) == 0 ||
400 strcmp(locale, "en_US.UTF-8") == 0) {
401 return setlocale(category, utf8_locale);
402 }
403 return setlocale(category, "C");
404 }
405 }
406
407 /* Android uses UTF-8, so explicitly set the locale to C.UTF-8 if none of
408 * LC_ALL, LC_CTYPE, or LANG is set to a non-empty string.
409 * Quote from POSIX section "8.2 Internationalization Variables":
410 * "4. If the LANG environment variable is not set or is set to the empty
411 * string, the implementation-defined default locale shall be used." */
412
413#ifdef PY_COERCE_C_LOCALE
414 coerce_c_locale = getenv("PYTHONCOERCECLOCALE");
415 if (coerce_c_locale == NULL || strcmp(coerce_c_locale, "0") != 0) {
416 /* Some other ported code may check the environment variables (e.g. in
417 * extension modules), so we make sure that they match the locale
418 * configuration */
419 if (setenv("LC_CTYPE", utf8_locale, 1)) {
420 fprintf(stderr, "Warning: failed setting the LC_CTYPE "
421 "environment variable to %s\n", utf8_locale);
422 }
423 }
424#endif
Victor Stinner353933e2018-11-23 13:08:26 +0100425 res = setlocale(category, utf8_locale);
426#else /* !defined(__ANDROID__) */
427 res = setlocale(category, "");
428#endif
429 _Py_ResetForceASCII();
430 return res;
xdegaye1588be62017-11-12 12:45:59 +0100431}
432
Nick Coghlan6ea41862017-06-11 13:16:15 +1000433
Eric Snow1abcf672017-05-23 21:46:51 -0700434/* Global initializations. Can be undone by Py_Finalize(). Don't
435 call this twice without an intervening Py_Finalize() call.
436
Victor Stinner331a6a52019-05-27 16:39:22 +0200437 Every call to Py_InitializeFromConfig, Py_Initialize or Py_InitializeEx
Eric Snow1abcf672017-05-23 21:46:51 -0700438 must have a corresponding call to Py_Finalize.
439
440 Locking: you must hold the interpreter lock while calling these APIs.
441 (If the lock has not yet been initialized, that's equivalent to
442 having the lock, but you cannot use multiple threads.)
443
444*/
445
Victor Stinner331a6a52019-05-27 16:39:22 +0200446static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200447pyinit_core_reconfigure(_PyRuntimeState *runtime,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200448 PyThreadState **tstate_p,
Victor Stinner331a6a52019-05-27 16:39:22 +0200449 const PyConfig *config)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200450{
Victor Stinner331a6a52019-05-27 16:39:22 +0200451 PyStatus status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100452 PyThreadState *tstate = _PyThreadState_GET();
453 if (!tstate) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200454 return _PyStatus_ERR("failed to read thread state");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100455 }
Victor Stinnerb45d2592019-06-20 00:05:23 +0200456 *tstate_p = tstate;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100457
458 PyInterpreterState *interp = tstate->interp;
459 if (interp == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200460 return _PyStatus_ERR("can't make main interpreter");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100461 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100462
Victor Stinnerdedaac02020-06-08 18:44:50 +0200463 status = _PyConfig_Write(config, runtime);
464 if (_PyStatus_EXCEPTION(status)) {
465 return status;
466 }
Victor Stinner1dc6e392018-07-25 02:49:17 +0200467
Victor Stinnerda7933e2020-04-13 03:04:28 +0200468 status = _PyInterpreterState_SetConfig(interp, config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200469 if (_PyStatus_EXCEPTION(status)) {
470 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200471 }
Victor Stinnerda7933e2020-04-13 03:04:28 +0200472 config = _PyInterpreterState_GetConfig(interp);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200473
Victor Stinner331a6a52019-05-27 16:39:22 +0200474 if (config->_install_importlib) {
Victor Stinner12f2f172019-09-26 15:51:50 +0200475 status = _PyConfig_WritePathConfig(config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200476 if (_PyStatus_EXCEPTION(status)) {
477 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200478 }
479 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200480 return _PyStatus_OK();
Victor Stinner1dc6e392018-07-25 02:49:17 +0200481}
482
483
Victor Stinner331a6a52019-05-27 16:39:22 +0200484static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200485pycore_init_runtime(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200486 const PyConfig *config)
Nick Coghland6009512014-11-20 21:39:37 +1000487{
Victor Stinner43125222019-04-24 18:23:53 +0200488 if (runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200489 return _PyStatus_ERR("main interpreter already initialized");
Victor Stinner1dc6e392018-07-25 02:49:17 +0200490 }
Victor Stinnerda273412017-12-15 01:46:02 +0100491
Victor Stinnerdedaac02020-06-08 18:44:50 +0200492 PyStatus status = _PyConfig_Write(config, runtime);
493 if (_PyStatus_EXCEPTION(status)) {
494 return status;
495 }
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600496
Eric Snow1abcf672017-05-23 21:46:51 -0700497 /* Py_Finalize leaves _Py_Finalizing set in order to help daemon
498 * threads behave a little more gracefully at interpreter shutdown.
499 * We clobber it here so the new interpreter can start with a clean
500 * slate.
501 *
502 * However, this may still lead to misbehaviour if there are daemon
503 * threads still hanging around from a previous Py_Initialize/Finalize
504 * pair :(
505 */
Victor Stinner7b3c2522020-03-07 00:24:23 +0100506 _PyRuntimeState_SetFinalizing(runtime, NULL);
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600507
Victor Stinnerdedaac02020-06-08 18:44:50 +0200508 status = _Py_HashRandomization_Init(config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200509 if (_PyStatus_EXCEPTION(status)) {
510 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800511 }
512
Victor Stinner331a6a52019-05-27 16:39:22 +0200513 status = _PyInterpreterState_Enable(runtime);
514 if (_PyStatus_EXCEPTION(status)) {
515 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -0800516 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200517 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100518}
Victor Stinnera7368ac2017-11-15 18:11:45 -0800519
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100520
Victor Stinner331a6a52019-05-27 16:39:22 +0200521static PyStatus
Victor Stinnerdda5d6e2020-04-08 17:54:59 +0200522init_interp_create_gil(PyThreadState *tstate)
523{
524 PyStatus status;
525
526 /* finalize_interp_delete() comment explains why _PyEval_FiniGIL() is
527 only called here. */
528 _PyEval_FiniGIL(tstate);
529
530 /* Auto-thread-state API */
531 status = _PyGILState_Init(tstate);
532 if (_PyStatus_EXCEPTION(status)) {
533 return status;
534 }
535
536 /* Create the GIL and take it */
537 status = _PyEval_InitGIL(tstate);
538 if (_PyStatus_EXCEPTION(status)) {
539 return status;
540 }
541
542 return _PyStatus_OK();
543}
544
545
546static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200547pycore_create_interpreter(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200548 const PyConfig *config,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200549 PyThreadState **tstate_p)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100550{
551 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnerda273412017-12-15 01:46:02 +0100552 if (interp == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200553 return _PyStatus_ERR("can't make main interpreter");
Victor Stinnerda273412017-12-15 01:46:02 +0100554 }
555
Victor Stinnerda7933e2020-04-13 03:04:28 +0200556 PyStatus status = _PyInterpreterState_SetConfig(interp, config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200557 if (_PyStatus_EXCEPTION(status)) {
558 return status;
Victor Stinnerda273412017-12-15 01:46:02 +0100559 }
Nick Coghland6009512014-11-20 21:39:37 +1000560
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200561 PyThreadState *tstate = PyThreadState_New(interp);
Victor Stinnerb45d2592019-06-20 00:05:23 +0200562 if (tstate == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200563 return _PyStatus_ERR("can't make first thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +0200564 }
Nick Coghland6009512014-11-20 21:39:37 +1000565 (void) PyThreadState_Swap(tstate);
566
Victor Stinnerdda5d6e2020-04-08 17:54:59 +0200567 status = init_interp_create_gil(tstate);
Victor Stinner111e4ee2020-03-09 21:24:14 +0100568 if (_PyStatus_EXCEPTION(status)) {
569 return status;
570 }
Victor Stinner2914bb32018-01-29 11:57:45 +0100571
Victor Stinnerb45d2592019-06-20 00:05:23 +0200572 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +0200573 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100574}
Nick Coghland6009512014-11-20 21:39:37 +1000575
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100576
Victor Stinner331a6a52019-05-27 16:39:22 +0200577static PyStatus
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100578pycore_init_types(PyThreadState *tstate)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100579{
Victor Stinner444b39b2019-11-20 01:18:11 +0100580 PyStatus status;
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100581 int is_main_interp = _Py_IsMainInterpreter(tstate);
Victor Stinner444b39b2019-11-20 01:18:11 +0100582
Victor Stinner01b1cc12019-11-20 02:27:56 +0100583 status = _PyGC_Init(tstate);
Victor Stinner444b39b2019-11-20 01:18:11 +0100584 if (_PyStatus_EXCEPTION(status)) {
585 return status;
586 }
587
Victor Stinnere7e699e2019-11-20 12:08:13 +0100588 if (is_main_interp) {
589 status = _PyTypes_Init();
590 if (_PyStatus_EXCEPTION(status)) {
591 return status;
592 }
Victor Stinner630c8df2019-12-17 13:02:18 +0100593 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100594
Victor Stinner630c8df2019-12-17 13:02:18 +0100595
596 if (!_PyLong_Init(tstate)) {
597 return _PyStatus_ERR("can't init longs");
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100598 }
Victor Stinneref5aa9a2019-11-20 00:38:03 +0100599
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100600 if (is_main_interp) {
Victor Stinnere7e699e2019-11-20 12:08:13 +0100601 status = _PyUnicode_Init();
602 if (_PyStatus_EXCEPTION(status)) {
603 return status;
604 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100605 }
606
Victor Stinner331a6a52019-05-27 16:39:22 +0200607 status = _PyExc_Init();
608 if (_PyStatus_EXCEPTION(status)) {
609 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100610 }
611
Victor Stinnere7e699e2019-11-20 12:08:13 +0100612 if (is_main_interp) {
613 if (!_PyFloat_Init()) {
614 return _PyStatus_ERR("can't init float");
615 }
Nick Coghland6009512014-11-20 21:39:37 +1000616
Victor Stinnere7e699e2019-11-20 12:08:13 +0100617 if (_PyStructSequence_Init() < 0) {
618 return _PyStatus_ERR("can't initialize structseq");
619 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100620 }
Victor Stinneref9d9b62019-05-22 11:28:22 +0200621
Victor Stinner331a6a52019-05-27 16:39:22 +0200622 status = _PyErr_Init();
623 if (_PyStatus_EXCEPTION(status)) {
624 return status;
Victor Stinneref9d9b62019-05-22 11:28:22 +0200625 }
626
Victor Stinnere7e699e2019-11-20 12:08:13 +0100627 if (is_main_interp) {
628 if (!_PyContext_Init()) {
629 return _PyStatus_ERR("can't init context");
630 }
Victor Stinneref5aa9a2019-11-20 00:38:03 +0100631 }
632
Victor Stinner331a6a52019-05-27 16:39:22 +0200633 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100634}
635
636
Victor Stinner331a6a52019-05-27 16:39:22 +0200637static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200638pycore_init_builtins(PyThreadState *tstate)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100639{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100640 assert(!_PyErr_Occurred(tstate));
641
Victor Stinnerb45d2592019-06-20 00:05:23 +0200642 PyObject *bimod = _PyBuiltin_Init(tstate);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100643 if (bimod == NULL) {
Victor Stinner2582d462019-11-22 19:24:49 +0100644 goto error;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100645 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100646
Victor Stinner2582d462019-11-22 19:24:49 +0100647 PyInterpreterState *interp = tstate->interp;
648 if (_PyImport_FixupBuiltin(bimod, "builtins", interp->modules) < 0) {
649 goto error;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100650 }
Victor Stinner2582d462019-11-22 19:24:49 +0100651
652 PyObject *builtins_dict = PyModule_GetDict(bimod);
653 if (builtins_dict == NULL) {
654 goto error;
655 }
656 Py_INCREF(builtins_dict);
657 interp->builtins = builtins_dict;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100658
Victor Stinner331a6a52019-05-27 16:39:22 +0200659 PyStatus status = _PyBuiltins_AddExceptions(bimod);
660 if (_PyStatus_EXCEPTION(status)) {
661 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100662 }
Victor Stinner2582d462019-11-22 19:24:49 +0100663
664 interp->builtins_copy = PyDict_Copy(interp->builtins);
665 if (interp->builtins_copy == NULL) {
666 goto error;
667 }
Pablo Galindob96c6b02019-12-04 11:19:59 +0000668 Py_DECREF(bimod);
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100669
670 assert(!_PyErr_Occurred(tstate));
671
Victor Stinner331a6a52019-05-27 16:39:22 +0200672 return _PyStatus_OK();
Victor Stinner2582d462019-11-22 19:24:49 +0100673
674error:
Pablo Galindob96c6b02019-12-04 11:19:59 +0000675 Py_XDECREF(bimod);
Victor Stinner2582d462019-11-22 19:24:49 +0100676 return _PyStatus_ERR("can't initialize builtins module");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100677}
678
679
Victor Stinner331a6a52019-05-27 16:39:22 +0200680static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200681pycore_init_import_warnings(PyThreadState *tstate, PyObject *sysmod)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100682{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100683 assert(!_PyErr_Occurred(tstate));
Victor Stinnerb45d2592019-06-20 00:05:23 +0200684
Victor Stinner2582d462019-11-22 19:24:49 +0100685 PyStatus status = _PyImportHooks_Init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200686 if (_PyStatus_EXCEPTION(status)) {
687 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800688 }
Nick Coghland6009512014-11-20 21:39:37 +1000689
Victor Stinnerda7933e2020-04-13 03:04:28 +0200690 const PyConfig *config = _PyInterpreterState_GetConfig(tstate->interp);
Victor Stinner2ec1a1b2019-11-22 21:54:33 +0100691 if (_Py_IsMainInterpreter(tstate)) {
692 /* Initialize _warnings. */
Victor Stinner66b79732020-03-02 15:02:18 +0100693 status = _PyWarnings_InitState(tstate);
694 if (_PyStatus_EXCEPTION(status)) {
695 return status;
Victor Stinner2ec1a1b2019-11-22 21:54:33 +0100696 }
Nick Coghland6009512014-11-20 21:39:37 +1000697
Victor Stinner2ec1a1b2019-11-22 21:54:33 +0100698 if (config->_install_importlib) {
699 status = _PyConfig_WritePathConfig(config);
700 if (_PyStatus_EXCEPTION(status)) {
701 return status;
702 }
Victor Stinnerb1147e42018-07-21 02:06:16 +0200703 }
704 }
705
Eric Snow1abcf672017-05-23 21:46:51 -0700706 /* This call sets up builtin and frozen import support */
Victor Stinnerb45d2592019-06-20 00:05:23 +0200707 if (config->_install_importlib) {
708 status = init_importlib(tstate, sysmod);
Victor Stinner331a6a52019-05-27 16:39:22 +0200709 if (_PyStatus_EXCEPTION(status)) {
710 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800711 }
Eric Snow1abcf672017-05-23 21:46:51 -0700712 }
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100713
714 assert(!_PyErr_Occurred(tstate));
715
Victor Stinner331a6a52019-05-27 16:39:22 +0200716 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100717}
718
719
Victor Stinner331a6a52019-05-27 16:39:22 +0200720static PyStatus
Victor Stinnerd863ade2019-12-06 03:37:07 +0100721pycore_interp_init(PyThreadState *tstate)
722{
723 PyStatus status;
Victor Stinner080ee5a2019-12-08 21:55:58 +0100724 PyObject *sysmod = NULL;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100725
726 status = pycore_init_types(tstate);
727 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100728 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100729 }
730
Victor Stinnerd863ade2019-12-06 03:37:07 +0100731 status = _PySys_Create(tstate, &sysmod);
732 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100733 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100734 }
735
736 status = pycore_init_builtins(tstate);
737 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100738 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100739 }
740
Victor Stinner080ee5a2019-12-08 21:55:58 +0100741 status = pycore_init_import_warnings(tstate, sysmod);
742
743done:
744 /* sys.modules['sys'] contains a strong reference to the module */
745 Py_XDECREF(sysmod);
746 return status;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100747}
748
749
750static PyStatus
Victor Stinner331a6a52019-05-27 16:39:22 +0200751pyinit_config(_PyRuntimeState *runtime,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200752 PyThreadState **tstate_p,
Victor Stinner331a6a52019-05-27 16:39:22 +0200753 const PyConfig *config)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100754{
Victor Stinner331a6a52019-05-27 16:39:22 +0200755 PyStatus status = pycore_init_runtime(runtime, config);
756 if (_PyStatus_EXCEPTION(status)) {
757 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100758 }
759
Victor Stinnerb45d2592019-06-20 00:05:23 +0200760 PyThreadState *tstate;
761 status = pycore_create_interpreter(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200762 if (_PyStatus_EXCEPTION(status)) {
763 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100764 }
Victor Stinnerb45d2592019-06-20 00:05:23 +0200765 *tstate_p = tstate;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100766
Victor Stinnerd863ade2019-12-06 03:37:07 +0100767 status = pycore_interp_init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200768 if (_PyStatus_EXCEPTION(status)) {
769 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100770 }
Eric Snow1abcf672017-05-23 21:46:51 -0700771
772 /* Only when we get here is the runtime core fully initialized */
Victor Stinner43125222019-04-24 18:23:53 +0200773 runtime->core_initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200774 return _PyStatus_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700775}
776
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100777
Victor Stinner331a6a52019-05-27 16:39:22 +0200778PyStatus
779_Py_PreInitializeFromPyArgv(const PyPreConfig *src_config, const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100780{
Victor Stinner331a6a52019-05-27 16:39:22 +0200781 PyStatus status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100782
Victor Stinner6d1c4672019-05-20 11:02:00 +0200783 if (src_config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200784 return _PyStatus_ERR("preinitialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +0200785 }
786
Victor Stinner331a6a52019-05-27 16:39:22 +0200787 status = _PyRuntime_Initialize();
788 if (_PyStatus_EXCEPTION(status)) {
789 return status;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100790 }
Victor Stinner43125222019-04-24 18:23:53 +0200791 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100792
Victor Stinnerd3b90412019-09-17 23:59:51 +0200793 if (runtime->preinitialized) {
Victor Stinnerf72346c2019-03-25 17:54:58 +0100794 /* If it's already configured: ignored the new configuration */
Victor Stinner331a6a52019-05-27 16:39:22 +0200795 return _PyStatus_OK();
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100796 }
797
Victor Stinnerd3b90412019-09-17 23:59:51 +0200798 /* Note: preinitialized remains 1 on error, it is only set to 0
799 at exit on success. */
800 runtime->preinitializing = 1;
801
Victor Stinner331a6a52019-05-27 16:39:22 +0200802 PyPreConfig config;
Victor Stinner441b10c2019-09-28 04:28:35 +0200803
804 status = _PyPreConfig_InitFromPreConfig(&config, src_config);
805 if (_PyStatus_EXCEPTION(status)) {
806 return status;
807 }
Victor Stinnerf72346c2019-03-25 17:54:58 +0100808
Victor Stinner331a6a52019-05-27 16:39:22 +0200809 status = _PyPreConfig_Read(&config, args);
810 if (_PyStatus_EXCEPTION(status)) {
811 return status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100812 }
813
Victor Stinner331a6a52019-05-27 16:39:22 +0200814 status = _PyPreConfig_Write(&config);
815 if (_PyStatus_EXCEPTION(status)) {
816 return status;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100817 }
818
Victor Stinnerd3b90412019-09-17 23:59:51 +0200819 runtime->preinitializing = 0;
820 runtime->preinitialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200821 return _PyStatus_OK();
Victor Stinnerf72346c2019-03-25 17:54:58 +0100822}
823
Victor Stinner70005ac2019-05-02 15:25:34 -0400824
Victor Stinner331a6a52019-05-27 16:39:22 +0200825PyStatus
826Py_PreInitializeFromBytesArgs(const PyPreConfig *src_config, Py_ssize_t argc, char **argv)
Victor Stinnerf72346c2019-03-25 17:54:58 +0100827{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100828 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400829 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100830}
831
832
Victor Stinner331a6a52019-05-27 16:39:22 +0200833PyStatus
834Py_PreInitializeFromArgs(const PyPreConfig *src_config, Py_ssize_t argc, wchar_t **argv)
Victor Stinner20004952019-03-26 02:31:11 +0100835{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100836 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400837 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinner20004952019-03-26 02:31:11 +0100838}
839
840
Victor Stinner331a6a52019-05-27 16:39:22 +0200841PyStatus
842Py_PreInitialize(const PyPreConfig *src_config)
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100843{
Victor Stinner70005ac2019-05-02 15:25:34 -0400844 return _Py_PreInitializeFromPyArgv(src_config, NULL);
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100845}
846
847
Victor Stinner331a6a52019-05-27 16:39:22 +0200848PyStatus
849_Py_PreInitializeFromConfig(const PyConfig *config,
850 const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100851{
Victor Stinner331a6a52019-05-27 16:39:22 +0200852 assert(config != NULL);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200853
Victor Stinner331a6a52019-05-27 16:39:22 +0200854 PyStatus status = _PyRuntime_Initialize();
855 if (_PyStatus_EXCEPTION(status)) {
856 return status;
Victor Stinner6d1c4672019-05-20 11:02:00 +0200857 }
858 _PyRuntimeState *runtime = &_PyRuntime;
859
Victor Stinnerd3b90412019-09-17 23:59:51 +0200860 if (runtime->preinitialized) {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200861 /* Already initialized: do nothing */
Victor Stinner331a6a52019-05-27 16:39:22 +0200862 return _PyStatus_OK();
Victor Stinner70005ac2019-05-02 15:25:34 -0400863 }
Victor Stinnercab5d072019-05-17 19:01:14 +0200864
Victor Stinner331a6a52019-05-27 16:39:22 +0200865 PyPreConfig preconfig;
Victor Stinner441b10c2019-09-28 04:28:35 +0200866
Victor Stinner3c30a762019-10-01 10:56:37 +0200867 _PyPreConfig_InitFromConfig(&preconfig, config);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200868
Victor Stinner331a6a52019-05-27 16:39:22 +0200869 if (!config->parse_argv) {
870 return Py_PreInitialize(&preconfig);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200871 }
872 else if (args == NULL) {
Victor Stinnercab5d072019-05-17 19:01:14 +0200873 _PyArgv config_args = {
874 .use_bytes_argv = 0,
Victor Stinner331a6a52019-05-27 16:39:22 +0200875 .argc = config->argv.length,
876 .wchar_argv = config->argv.items};
Victor Stinner6d1c4672019-05-20 11:02:00 +0200877 return _Py_PreInitializeFromPyArgv(&preconfig, &config_args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200878 }
879 else {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200880 return _Py_PreInitializeFromPyArgv(&preconfig, args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200881 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100882}
883
884
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100885/* Begin interpreter initialization
886 *
887 * On return, the first thread and interpreter state have been created,
888 * but the compiler, signal handling, multithreading and
889 * multiple interpreter support, and codec infrastructure are not yet
890 * available.
891 *
892 * The import system will support builtin and frozen modules only.
893 * The only supported io is writing to sys.stderr
894 *
895 * If any operation invoked by this function fails, a fatal error is
896 * issued and the function does not return.
897 *
898 * Any code invoked from this function should *not* assume it has access
899 * to the Python C API (unless the API is explicitly listed as being
900 * safe to call without calling Py_Initialize first)
901 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200902static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200903pyinit_core(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200904 const PyConfig *src_config,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200905 PyThreadState **tstate_p)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200906{
Victor Stinner331a6a52019-05-27 16:39:22 +0200907 PyStatus status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200908
Victor Stinner331a6a52019-05-27 16:39:22 +0200909 status = _Py_PreInitializeFromConfig(src_config, NULL);
910 if (_PyStatus_EXCEPTION(status)) {
911 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200912 }
913
Victor Stinner331a6a52019-05-27 16:39:22 +0200914 PyConfig config;
Victor Stinner8462a492019-10-01 12:06:16 +0200915 _PyConfig_InitCompatConfig(&config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200916
Victor Stinner331a6a52019-05-27 16:39:22 +0200917 status = _PyConfig_Copy(&config, src_config);
918 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200919 goto done;
920 }
921
Victor Stinner331a6a52019-05-27 16:39:22 +0200922 status = PyConfig_Read(&config);
923 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200924 goto done;
925 }
926
927 if (!runtime->core_initialized) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200928 status = pyinit_config(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200929 }
930 else {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200931 status = pyinit_core_reconfigure(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200932 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200933 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200934 goto done;
935 }
936
937done:
Victor Stinner331a6a52019-05-27 16:39:22 +0200938 PyConfig_Clear(&config);
939 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200940}
941
Victor Stinner5ac27a52019-03-27 13:40:14 +0100942
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200943/* Py_Initialize() has already been called: update the main interpreter
944 configuration. Example of bpo-34008: Py_Main() called after
945 Py_Initialize(). */
Victor Stinner331a6a52019-05-27 16:39:22 +0200946static PyStatus
Victor Stinnerb0051362019-11-22 17:52:42 +0100947_Py_ReconfigureMainInterpreter(PyThreadState *tstate)
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200948{
Victor Stinnerda7933e2020-04-13 03:04:28 +0200949 const PyConfig *config = _PyInterpreterState_GetConfig(tstate->interp);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100950
Victor Stinner331a6a52019-05-27 16:39:22 +0200951 PyObject *argv = _PyWideStringList_AsList(&config->argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100952 if (argv == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200953 return _PyStatus_NO_MEMORY(); \
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100954 }
955
Victor Stinnerb0051362019-11-22 17:52:42 +0100956 int res = PyDict_SetItemString(tstate->interp->sysdict, "argv", argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100957 Py_DECREF(argv);
958 if (res < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200959 return _PyStatus_ERR("fail to set sys.argv");
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200960 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200961 return _PyStatus_OK();
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200962}
963
Victor Stinnerb0051362019-11-22 17:52:42 +0100964
965static PyStatus
966init_interp_main(PyThreadState *tstate)
967{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100968 assert(!_PyErr_Occurred(tstate));
969
Victor Stinnerb0051362019-11-22 17:52:42 +0100970 PyStatus status;
971 int is_main_interp = _Py_IsMainInterpreter(tstate);
972 PyInterpreterState *interp = tstate->interp;
Victor Stinnerda7933e2020-04-13 03:04:28 +0200973 const PyConfig *config = _PyInterpreterState_GetConfig(interp);
Victor Stinnerb0051362019-11-22 17:52:42 +0100974
975 if (!config->_install_importlib) {
976 /* Special mode for freeze_importlib: run with no import system
977 *
978 * This means anything which needs support from extension modules
979 * or pure Python code in the standard library won't work.
980 */
981 if (is_main_interp) {
982 interp->runtime->initialized = 1;
983 }
984 return _PyStatus_OK();
985 }
986
987 if (is_main_interp) {
988 if (_PyTime_Init() < 0) {
989 return _PyStatus_ERR("can't initialize time");
990 }
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100991 }
Victor Stinnerb0051362019-11-22 17:52:42 +0100992
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100993 if (_PySys_InitMain(tstate) < 0) {
994 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerb0051362019-11-22 17:52:42 +0100995 }
996
997 status = init_importlib_external(tstate);
998 if (_PyStatus_EXCEPTION(status)) {
999 return status;
1000 }
1001
1002 if (is_main_interp) {
1003 /* initialize the faulthandler module */
1004 status = _PyFaulthandler_Init(config->faulthandler);
1005 if (_PyStatus_EXCEPTION(status)) {
1006 return status;
1007 }
1008 }
1009
1010 status = _PyUnicode_InitEncodings(tstate);
1011 if (_PyStatus_EXCEPTION(status)) {
1012 return status;
1013 }
1014
1015 if (is_main_interp) {
1016 if (config->install_signal_handlers) {
1017 status = init_signals(tstate);
1018 if (_PyStatus_EXCEPTION(status)) {
1019 return status;
1020 }
1021 }
1022
1023 if (_PyTraceMalloc_Init(config->tracemalloc) < 0) {
1024 return _PyStatus_ERR("can't initialize tracemalloc");
1025 }
1026 }
1027
1028 status = init_sys_streams(tstate);
1029 if (_PyStatus_EXCEPTION(status)) {
1030 return status;
1031 }
1032
Andy Lester75cd5bf2020-03-12 02:49:05 -05001033 status = init_set_builtins_open();
Victor Stinnerb0051362019-11-22 17:52:42 +01001034 if (_PyStatus_EXCEPTION(status)) {
1035 return status;
1036 }
1037
1038 status = add_main_module(interp);
1039 if (_PyStatus_EXCEPTION(status)) {
1040 return status;
1041 }
1042
1043 if (is_main_interp) {
1044 /* Initialize warnings. */
1045 PyObject *warnoptions = PySys_GetObject("warnoptions");
1046 if (warnoptions != NULL && PyList_Size(warnoptions) > 0)
1047 {
1048 PyObject *warnings_module = PyImport_ImportModule("warnings");
1049 if (warnings_module == NULL) {
1050 fprintf(stderr, "'import warnings' failed; traceback:\n");
1051 _PyErr_Print(tstate);
1052 }
1053 Py_XDECREF(warnings_module);
1054 }
1055
1056 interp->runtime->initialized = 1;
1057 }
1058
1059 if (config->site_import) {
1060 status = init_import_site();
1061 if (_PyStatus_EXCEPTION(status)) {
1062 return status;
1063 }
1064 }
1065
1066 if (is_main_interp) {
1067#ifndef MS_WINDOWS
1068 emit_stderr_warning_for_legacy_locale(interp->runtime);
1069#endif
1070 }
1071
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001072 assert(!_PyErr_Occurred(tstate));
1073
Victor Stinnerb0051362019-11-22 17:52:42 +01001074 return _PyStatus_OK();
1075}
1076
1077
Eric Snowc7ec9982017-05-23 23:00:52 -07001078/* Update interpreter state based on supplied configuration settings
1079 *
1080 * After calling this function, most of the restrictions on the interpreter
1081 * are lifted. The only remaining incomplete settings are those related
1082 * to the main module (sys.argv[0], __main__ metadata)
1083 *
1084 * Calling this when the interpreter is not initializing, is already
1085 * initialized or without a valid current thread state is a fatal error.
1086 * Other errors should be reported as normal Python exceptions with a
1087 * non-zero return code.
1088 */
Victor Stinner331a6a52019-05-27 16:39:22 +02001089static PyStatus
Victor Stinner01b1cc12019-11-20 02:27:56 +01001090pyinit_main(PyThreadState *tstate)
Eric Snow1abcf672017-05-23 21:46:51 -07001091{
Victor Stinnerb0051362019-11-22 17:52:42 +01001092 PyInterpreterState *interp = tstate->interp;
1093 if (!interp->runtime->core_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001094 return _PyStatus_ERR("runtime core not initialized");
Eric Snowc7ec9982017-05-23 23:00:52 -07001095 }
Eric Snowc7ec9982017-05-23 23:00:52 -07001096
Victor Stinnerb0051362019-11-22 17:52:42 +01001097 if (interp->runtime->initialized) {
1098 return _Py_ReconfigureMainInterpreter(tstate);
Victor Stinnerfb47bca2018-07-20 17:34:23 +02001099 }
1100
Victor Stinnerb0051362019-11-22 17:52:42 +01001101 PyStatus status = init_interp_main(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001102 if (_PyStatus_EXCEPTION(status)) {
1103 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001104 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001105 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001106}
1107
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001108
Victor Stinner331a6a52019-05-27 16:39:22 +02001109PyStatus
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001110_Py_InitializeMain(void)
1111{
Victor Stinner331a6a52019-05-27 16:39:22 +02001112 PyStatus status = _PyRuntime_Initialize();
1113 if (_PyStatus_EXCEPTION(status)) {
1114 return status;
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001115 }
1116 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinnerb45d2592019-06-20 00:05:23 +02001117 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
Victor Stinner01b1cc12019-11-20 02:27:56 +01001118 return pyinit_main(tstate);
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001119}
1120
1121
Victor Stinner331a6a52019-05-27 16:39:22 +02001122PyStatus
1123Py_InitializeFromConfig(const PyConfig *config)
Eric Snow1abcf672017-05-23 21:46:51 -07001124{
Victor Stinner6d1c4672019-05-20 11:02:00 +02001125 if (config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001126 return _PyStatus_ERR("initialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +02001127 }
1128
Victor Stinner331a6a52019-05-27 16:39:22 +02001129 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001130
Victor Stinner331a6a52019-05-27 16:39:22 +02001131 status = _PyRuntime_Initialize();
1132 if (_PyStatus_EXCEPTION(status)) {
1133 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001134 }
1135 _PyRuntimeState *runtime = &_PyRuntime;
1136
Victor Stinnerb45d2592019-06-20 00:05:23 +02001137 PyThreadState *tstate = NULL;
1138 status = pyinit_core(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001139 if (_PyStatus_EXCEPTION(status)) {
1140 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001141 }
Victor Stinnerda7933e2020-04-13 03:04:28 +02001142 config = _PyInterpreterState_GetConfig(tstate->interp);
Victor Stinnerbc8ac6b2017-11-30 18:03:55 +01001143
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001144 if (config->_init_main) {
Victor Stinner01b1cc12019-11-20 02:27:56 +01001145 status = pyinit_main(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001146 if (_PyStatus_EXCEPTION(status)) {
1147 return status;
Victor Stinner484f20d2019-03-27 02:04:16 +01001148 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001149 }
Victor Stinner484f20d2019-03-27 02:04:16 +01001150
Victor Stinner331a6a52019-05-27 16:39:22 +02001151 return _PyStatus_OK();
Victor Stinner5ac27a52019-03-27 13:40:14 +01001152}
1153
1154
Eric Snow1abcf672017-05-23 21:46:51 -07001155void
Nick Coghland6009512014-11-20 21:39:37 +10001156Py_InitializeEx(int install_sigs)
1157{
Victor Stinner331a6a52019-05-27 16:39:22 +02001158 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001159
Victor Stinner331a6a52019-05-27 16:39:22 +02001160 status = _PyRuntime_Initialize();
1161 if (_PyStatus_EXCEPTION(status)) {
1162 Py_ExitStatusException(status);
Victor Stinner43125222019-04-24 18:23:53 +02001163 }
1164 _PyRuntimeState *runtime = &_PyRuntime;
1165
1166 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001167 /* bpo-33932: Calling Py_Initialize() twice does nothing. */
1168 return;
1169 }
1170
Victor Stinner331a6a52019-05-27 16:39:22 +02001171 PyConfig config;
Victor Stinner8462a492019-10-01 12:06:16 +02001172 _PyConfig_InitCompatConfig(&config);
Victor Stinner441b10c2019-09-28 04:28:35 +02001173
Victor Stinner1dc6e392018-07-25 02:49:17 +02001174 config.install_signal_handlers = install_sigs;
1175
Victor Stinner331a6a52019-05-27 16:39:22 +02001176 status = Py_InitializeFromConfig(&config);
1177 if (_PyStatus_EXCEPTION(status)) {
1178 Py_ExitStatusException(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001179 }
Nick Coghland6009512014-11-20 21:39:37 +10001180}
1181
1182void
1183Py_Initialize(void)
1184{
1185 Py_InitializeEx(1);
1186}
1187
1188
Nick Coghland6009512014-11-20 21:39:37 +10001189/* Flush stdout and stderr */
1190
1191static int
1192file_is_closed(PyObject *fobj)
1193{
1194 int r;
1195 PyObject *tmp = PyObject_GetAttrString(fobj, "closed");
1196 if (tmp == NULL) {
1197 PyErr_Clear();
1198 return 0;
1199 }
1200 r = PyObject_IsTrue(tmp);
1201 Py_DECREF(tmp);
1202 if (r < 0)
1203 PyErr_Clear();
1204 return r > 0;
1205}
1206
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001207static int
Nick Coghland6009512014-11-20 21:39:37 +10001208flush_std_files(void)
1209{
1210 PyObject *fout = _PySys_GetObjectId(&PyId_stdout);
1211 PyObject *ferr = _PySys_GetObjectId(&PyId_stderr);
1212 PyObject *tmp;
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001213 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001214
1215 if (fout != NULL && fout != Py_None && !file_is_closed(fout)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001216 tmp = _PyObject_CallMethodIdNoArgs(fout, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001217 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001218 PyErr_WriteUnraisable(fout);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001219 status = -1;
1220 }
Nick Coghland6009512014-11-20 21:39:37 +10001221 else
1222 Py_DECREF(tmp);
1223 }
1224
1225 if (ferr != NULL && ferr != Py_None && !file_is_closed(ferr)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001226 tmp = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001227 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001228 PyErr_Clear();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001229 status = -1;
1230 }
Nick Coghland6009512014-11-20 21:39:37 +10001231 else
1232 Py_DECREF(tmp);
1233 }
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001234
1235 return status;
Nick Coghland6009512014-11-20 21:39:37 +10001236}
1237
1238/* Undo the effect of Py_Initialize().
1239
1240 Beware: if multiple interpreter and/or thread states exist, these
1241 are not wiped out; only the current thread and interpreter state
1242 are deleted. But since everything else is deleted, those other
1243 interpreter and thread states should no longer be used.
1244
1245 (XXX We should do better, e.g. wipe out all interpreters and
1246 threads.)
1247
1248 Locking: as above.
1249
1250*/
1251
Victor Stinner7eee5be2019-11-20 10:38:34 +01001252
1253static void
1254finalize_interp_types(PyThreadState *tstate, int is_main_interp)
1255{
1256 if (is_main_interp) {
1257 /* Sundry finalizers */
Pablo Galindo55e08362020-09-15 19:32:56 +01001258 _PyAST_Fini();
Victor Stinner7eee5be2019-11-20 10:38:34 +01001259 _PyFrame_Fini();
Victor Stinner7eee5be2019-11-20 10:38:34 +01001260 _PyTuple_Fini();
1261 _PyList_Fini();
1262 _PySet_Fini();
1263 _PyBytes_Fini();
Victor Stinner630c8df2019-12-17 13:02:18 +01001264 }
1265
1266 _PyLong_Fini(tstate);
1267
1268 if (is_main_interp) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001269 _PyFloat_Fini();
1270 _PyDict_Fini();
1271 _PySlice_Fini();
1272 }
1273
1274 _PyWarnings_Fini(tstate->interp);
1275
1276 if (is_main_interp) {
1277 _Py_HashRandomization_Fini();
1278 _PyArg_Fini();
1279 _PyAsyncGen_Fini();
1280 _PyContext_Fini();
Victor Stinner3d483342019-11-22 12:27:50 +01001281 }
Victor Stinner7eee5be2019-11-20 10:38:34 +01001282
Victor Stinner3d483342019-11-22 12:27:50 +01001283 /* Cleanup Unicode implementation */
1284 _PyUnicode_Fini(tstate);
1285
1286 if (is_main_interp) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001287 _Py_ClearFileSystemEncoding();
1288 }
1289}
1290
1291
1292static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001293finalize_interp_clear(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001294{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001295 int is_main_interp = _Py_IsMainInterpreter(tstate);
1296
Victor Stinner7eee5be2019-11-20 10:38:34 +01001297 /* Clear interpreter state and all thread states */
1298 PyInterpreterState_Clear(tstate->interp);
1299
Pablo Galindoac0e1c22019-12-04 11:51:03 +00001300 /* Trigger a GC collection on subinterpreters*/
1301 if (!is_main_interp) {
1302 _PyGC_CollectNoFail();
1303 }
1304
Steve Dowere1d4fdc2020-07-03 22:58:29 +01001305 /* Clear all loghooks */
1306 /* Both _PySys_Audit function and users still need PyObject, such as tuple.
1307 Call _PySys_ClearAuditHooks when PyObject available. */
1308 if (is_main_interp) {
1309 _PySys_ClearAuditHooks(tstate);
1310 }
1311
Steve Dower941117a2020-07-03 23:34:46 +01001312 finalize_interp_types(tstate, is_main_interp);
1313
Victor Stinner7eee5be2019-11-20 10:38:34 +01001314 if (is_main_interp) {
1315 /* XXX Still allocated:
1316 - various static ad-hoc pointers to interned strings
1317 - int and float free list blocks
1318 - whatever various modules and libraries allocate
1319 */
1320
1321 PyGrammar_RemoveAccelerators(&_PyParser_Grammar);
1322
1323 _PyExc_Fini();
Victor Stinner7eee5be2019-11-20 10:38:34 +01001324 }
Victor Stinner72474072019-11-20 12:25:50 +01001325
1326 _PyGC_Fini(tstate);
Victor Stinner7eee5be2019-11-20 10:38:34 +01001327}
1328
1329
1330static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001331finalize_interp_delete(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001332{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001333 if (_Py_IsMainInterpreter(tstate)) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001334 /* Cleanup auto-thread-state */
1335 _PyGILState_Fini(tstate);
1336 }
1337
Victor Stinnerdda5d6e2020-04-08 17:54:59 +02001338 /* We can't call _PyEval_FiniGIL() here because destroying the GIL lock can
1339 fail when it is being awaited by another running daemon thread (see
1340 bpo-9901). Instead pycore_create_interpreter() destroys the previously
1341 created GIL, which ensures that Py_Initialize / Py_FinalizeEx can be
1342 called multiple times. */
1343
Victor Stinner7eee5be2019-11-20 10:38:34 +01001344 PyInterpreterState_Delete(tstate->interp);
1345}
1346
1347
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001348int
1349Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001350{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001351 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001352
Victor Stinner8e91c242019-04-24 17:24:01 +02001353 _PyRuntimeState *runtime = &_PyRuntime;
1354 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001355 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001356 }
Nick Coghland6009512014-11-20 21:39:37 +10001357
Victor Stinnere225beb2019-06-03 18:14:24 +02001358 /* Get current thread state and interpreter pointer */
1359 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
1360 PyInterpreterState *interp = tstate->interp;
Victor Stinner8e91c242019-04-24 17:24:01 +02001361
Victor Stinnerb45d2592019-06-20 00:05:23 +02001362 // Wrap up existing "threading"-module-created, non-daemon threads.
1363 wait_for_thread_shutdown(tstate);
1364
1365 // Make any remaining pending calls.
Victor Stinner2b1df452020-01-13 18:46:59 +01001366 _Py_FinishPendingCalls(tstate);
Victor Stinnerb45d2592019-06-20 00:05:23 +02001367
Nick Coghland6009512014-11-20 21:39:37 +10001368 /* The interpreter is still entirely intact at this point, and the
1369 * exit funcs may be relying on that. In particular, if some thread
1370 * or exit func is still waiting to do an import, the import machinery
1371 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001372 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001373 * Note that Threading.py uses an exit func to do a join on all the
1374 * threads created thru it, so this also protects pending imports in
1375 * the threads created via Threading.
1376 */
Nick Coghland6009512014-11-20 21:39:37 +10001377
Victor Stinnerb45d2592019-06-20 00:05:23 +02001378 call_py_exitfuncs(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001379
Victor Stinnerda273412017-12-15 01:46:02 +01001380 /* Copy the core config, PyInterpreterState_Delete() free
1381 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001382#ifdef Py_REF_DEBUG
Victor Stinner331a6a52019-05-27 16:39:22 +02001383 int show_ref_count = interp->config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001384#endif
1385#ifdef Py_TRACE_REFS
Victor Stinner331a6a52019-05-27 16:39:22 +02001386 int dump_refs = interp->config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001387#endif
1388#ifdef WITH_PYMALLOC
Victor Stinner331a6a52019-05-27 16:39:22 +02001389 int malloc_stats = interp->config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001390#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001391
Victor Stinnereb4e2ae2020-03-08 11:57:45 +01001392 /* Remaining daemon threads will automatically exit
1393 when they attempt to take the GIL (ex: PyEval_RestoreThread()). */
Victor Stinner7b3c2522020-03-07 00:24:23 +01001394 _PyRuntimeState_SetFinalizing(runtime, tstate);
Victor Stinner8e91c242019-04-24 17:24:01 +02001395 runtime->initialized = 0;
1396 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001397
Victor Stinner9ad58ac2020-03-09 23:37:49 +01001398 /* Destroy the state of all threads of the interpreter, except of the
1399 current thread. In practice, only daemon threads should still be alive,
1400 except if wait_for_thread_shutdown() has been cancelled by CTRL+C.
1401 Clear frames of other threads to call objects destructors. Destructors
1402 will be called in the current Python thread. Since
1403 _PyRuntimeState_SetFinalizing() has been called, no other Python thread
1404 can take the GIL at this point: if they try, they will exit
1405 immediately. */
1406 _PyThreadState_DeleteExcept(runtime, tstate);
1407
Victor Stinnere0deff32015-03-24 13:46:18 +01001408 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001409 if (flush_std_files() < 0) {
1410 status = -1;
1411 }
Nick Coghland6009512014-11-20 21:39:37 +10001412
1413 /* Disable signal handling */
1414 PyOS_FiniInterrupts();
1415
1416 /* Collect garbage. This may call finalizers; it's nice to call these
1417 * before all modules are destroyed.
1418 * XXX If a __del__ or weakref callback is triggered here, and tries to
1419 * XXX import a module, bad things can happen, because Python no
1420 * XXX longer believes it's initialized.
1421 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1422 * XXX is easy to provoke that way. I've also seen, e.g.,
1423 * XXX Exception exceptions.ImportError: 'No module named sha'
1424 * XXX in <function callback at 0x008F5718> ignored
1425 * XXX but I'm unclear on exactly how that one happens. In any case,
1426 * XXX I haven't seen a real-life report of either of these.
1427 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001428 _PyGC_CollectIfEnabled();
Eric Snowdae02762017-09-14 00:35:58 -07001429
Nick Coghland6009512014-11-20 21:39:37 +10001430 /* Destroy all modules */
Victor Stinner987a0dc2019-06-19 10:36:10 +02001431 _PyImport_Cleanup(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001432
Inada Naoki91234a12019-06-03 21:30:58 +09001433 /* Print debug stats if any */
1434 _PyEval_Fini();
1435
Victor Stinnere0deff32015-03-24 13:46:18 +01001436 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001437 if (flush_std_files() < 0) {
1438 status = -1;
1439 }
Nick Coghland6009512014-11-20 21:39:37 +10001440
1441 /* Collect final garbage. This disposes of cycles created by
1442 * class definitions, for example.
1443 * XXX This is disabled because it caused too many problems. If
1444 * XXX a __del__ or weakref callback triggers here, Python code has
1445 * XXX a hard time running, because even the sys module has been
1446 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1447 * XXX One symptom is a sequence of information-free messages
1448 * XXX coming from threads (if a __del__ or callback is invoked,
1449 * XXX other threads can execute too, and any exception they encounter
1450 * XXX triggers a comedy of errors as subsystem after subsystem
1451 * XXX fails to find what it *expects* to find in sys to help report
1452 * XXX the exception and consequent unexpected failures). I've also
1453 * XXX seen segfaults then, after adding print statements to the
1454 * XXX Python code getting called.
1455 */
1456#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001457 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001458#endif
1459
1460 /* Disable tracemalloc after all Python objects have been destroyed,
1461 so it is possible to use tracemalloc in objects destructor. */
1462 _PyTraceMalloc_Fini();
1463
1464 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1465 _PyImport_Fini();
1466
1467 /* Cleanup typeobject.c's internal caches. */
1468 _PyType_Fini();
1469
1470 /* unload faulthandler module */
1471 _PyFaulthandler_Fini();
1472
Nick Coghland6009512014-11-20 21:39:37 +10001473 /* dump hash stats */
1474 _PyHash_Fini();
1475
Eric Snowdae02762017-09-14 00:35:58 -07001476#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001477 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001478 _PyDebug_PrintTotalRefs();
1479 }
Eric Snowdae02762017-09-14 00:35:58 -07001480#endif
Nick Coghland6009512014-11-20 21:39:37 +10001481
1482#ifdef Py_TRACE_REFS
1483 /* Display all objects still alive -- this can invoke arbitrary
1484 * __repr__ overrides, so requires a mostly-intact interpreter.
1485 * Alas, a lot of stuff may still be alive now that will be cleaned
1486 * up later.
1487 */
Victor Stinnerda273412017-12-15 01:46:02 +01001488 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001489 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001490 }
Nick Coghland6009512014-11-20 21:39:37 +10001491#endif /* Py_TRACE_REFS */
1492
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001493 finalize_interp_clear(tstate);
1494 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001495
1496#ifdef Py_TRACE_REFS
1497 /* Display addresses (& refcnts) of all objects still alive.
1498 * An address can be used to find the repr of the object, printed
1499 * above by _Py_PrintReferences.
1500 */
Victor Stinnerda273412017-12-15 01:46:02 +01001501 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001502 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001503 }
Nick Coghland6009512014-11-20 21:39:37 +10001504#endif /* Py_TRACE_REFS */
Victor Stinner34be8072016-03-14 12:04:26 +01001505#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001506 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001507 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be8072016-03-14 12:04:26 +01001508 }
Nick Coghland6009512014-11-20 21:39:37 +10001509#endif
1510
Victor Stinner8e91c242019-04-24 17:24:01 +02001511 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001512
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001513 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001514 return status;
1515}
1516
1517void
1518Py_Finalize(void)
1519{
1520 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001521}
1522
Victor Stinnerb0051362019-11-22 17:52:42 +01001523
Nick Coghland6009512014-11-20 21:39:37 +10001524/* Create and initialize a new interpreter and thread, and return the
1525 new thread. This requires that Py_Initialize() has been called
1526 first.
1527
1528 Unsuccessful initialization yields a NULL pointer. Note that *no*
1529 exception information is available even in this case -- the
1530 exception information is held in the thread, and there is no
1531 thread.
1532
1533 Locking: as above.
1534
1535*/
1536
Victor Stinner331a6a52019-05-27 16:39:22 +02001537static PyStatus
Victor Stinner252346a2020-05-01 11:33:44 +02001538new_interpreter(PyThreadState **tstate_p, int isolated_subinterpreter)
Nick Coghland6009512014-11-20 21:39:37 +10001539{
Victor Stinner331a6a52019-05-27 16:39:22 +02001540 PyStatus status;
Nick Coghland6009512014-11-20 21:39:37 +10001541
Victor Stinner331a6a52019-05-27 16:39:22 +02001542 status = _PyRuntime_Initialize();
1543 if (_PyStatus_EXCEPTION(status)) {
1544 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001545 }
1546 _PyRuntimeState *runtime = &_PyRuntime;
1547
1548 if (!runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001549 return _PyStatus_ERR("Py_Initialize must be called first");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001550 }
Nick Coghland6009512014-11-20 21:39:37 +10001551
Victor Stinner8a1be612016-03-14 22:07:55 +01001552 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1553 interpreters: disable PyGILState_Check(). */
Victor Stinner1c4cbdf2020-04-13 11:45:21 +02001554 runtime->gilstate.check_enabled = 0;
Victor Stinner8a1be612016-03-14 22:07:55 +01001555
Victor Stinner43125222019-04-24 18:23:53 +02001556 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001557 if (interp == NULL) {
1558 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001559 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001560 }
Nick Coghland6009512014-11-20 21:39:37 +10001561
Victor Stinner43125222019-04-24 18:23:53 +02001562 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001563 if (tstate == NULL) {
1564 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001565 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001566 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001567 }
1568
Victor Stinner43125222019-04-24 18:23:53 +02001569 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001570
Eric Snow1abcf672017-05-23 21:46:51 -07001571 /* Copy the current interpreter config into the new interpreter */
Victor Stinnerda7933e2020-04-13 03:04:28 +02001572 const PyConfig *config;
Eric Snow1abcf672017-05-23 21:46:51 -07001573 if (save_tstate != NULL) {
Victor Stinnerda7933e2020-04-13 03:04:28 +02001574 config = _PyInterpreterState_GetConfig(save_tstate->interp);
Victor Stinner7be4e352020-05-05 20:27:47 +02001575 }
1576 else
Victor Stinner7be4e352020-05-05 20:27:47 +02001577 {
Eric Snow1abcf672017-05-23 21:46:51 -07001578 /* No current thread state, copy from the main interpreter */
1579 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinnerda7933e2020-04-13 03:04:28 +02001580 config = _PyInterpreterState_GetConfig(main_interp);
Victor Stinnerda273412017-12-15 01:46:02 +01001581 }
1582
Victor Stinnerda7933e2020-04-13 03:04:28 +02001583 status = _PyInterpreterState_SetConfig(interp, config);
Victor Stinner331a6a52019-05-27 16:39:22 +02001584 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001585 goto error;
Victor Stinnerda273412017-12-15 01:46:02 +01001586 }
Victor Stinner252346a2020-05-01 11:33:44 +02001587 interp->config._isolated_interpreter = isolated_subinterpreter;
Eric Snow1abcf672017-05-23 21:46:51 -07001588
Victor Stinner0dd5e7a2020-05-05 20:16:37 +02001589 status = init_interp_create_gil(tstate);
1590 if (_PyStatus_EXCEPTION(status)) {
1591 goto error;
1592 }
1593
Victor Stinnerd863ade2019-12-06 03:37:07 +01001594 status = pycore_interp_init(tstate);
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001595 if (_PyStatus_EXCEPTION(status)) {
1596 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001597 }
1598
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001599 status = init_interp_main(tstate);
1600 if (_PyStatus_EXCEPTION(status)) {
1601 goto error;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001602 }
Nick Coghland6009512014-11-20 21:39:37 +10001603
Victor Stinnera7368ac2017-11-15 18:11:45 -08001604 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +02001605 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001606
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001607error:
Victor Stinnerb0051362019-11-22 17:52:42 +01001608 *tstate_p = NULL;
1609
1610 /* Oops, it didn't work. Undo it all. */
Nick Coghland6009512014-11-20 21:39:37 +10001611 PyErr_PrintEx(0);
1612 PyThreadState_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001613 PyThreadState_Delete(tstate);
1614 PyInterpreterState_Delete(interp);
Victor Stinner9da74302019-11-20 11:17:17 +01001615 PyThreadState_Swap(save_tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001616
Victor Stinnerb0051362019-11-22 17:52:42 +01001617 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001618}
1619
1620PyThreadState *
Victor Stinner252346a2020-05-01 11:33:44 +02001621_Py_NewInterpreter(int isolated_subinterpreter)
Victor Stinnera7368ac2017-11-15 18:11:45 -08001622{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001623 PyThreadState *tstate = NULL;
Victor Stinner252346a2020-05-01 11:33:44 +02001624 PyStatus status = new_interpreter(&tstate, isolated_subinterpreter);
Victor Stinner331a6a52019-05-27 16:39:22 +02001625 if (_PyStatus_EXCEPTION(status)) {
1626 Py_ExitStatusException(status);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001627 }
1628 return tstate;
1629
Nick Coghland6009512014-11-20 21:39:37 +10001630}
1631
Victor Stinner252346a2020-05-01 11:33:44 +02001632PyThreadState *
1633Py_NewInterpreter(void)
1634{
1635 return _Py_NewInterpreter(0);
1636}
1637
Nick Coghland6009512014-11-20 21:39:37 +10001638/* Delete an interpreter and its last thread. This requires that the
1639 given thread state is current, that the thread has no remaining
1640 frames, and that it is its interpreter's only remaining thread.
1641 It is a fatal error to violate these constraints.
1642
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001643 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001644 everything, regardless.)
1645
1646 Locking: as above.
1647
1648*/
1649
1650void
1651Py_EndInterpreter(PyThreadState *tstate)
1652{
1653 PyInterpreterState *interp = tstate->interp;
1654
Victor Stinnerb45d2592019-06-20 00:05:23 +02001655 if (tstate != _PyThreadState_GET()) {
Victor Stinner9e5d30c2020-03-07 00:54:20 +01001656 Py_FatalError("thread is not current");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001657 }
1658 if (tstate->frame != NULL) {
Victor Stinner9e5d30c2020-03-07 00:54:20 +01001659 Py_FatalError("thread still has a frame");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001660 }
Eric Snow5be45a62019-03-08 22:47:07 -07001661 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001662
Eric Snow842a2f02019-03-15 15:47:51 -06001663 // Wrap up existing "threading"-module-created, non-daemon threads.
Victor Stinnerb45d2592019-06-20 00:05:23 +02001664 wait_for_thread_shutdown(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001665
Victor Stinnerb45d2592019-06-20 00:05:23 +02001666 call_py_exitfuncs(tstate);
Marcel Plch776407f2017-12-20 11:17:58 +01001667
Victor Stinnerb45d2592019-06-20 00:05:23 +02001668 if (tstate != interp->tstate_head || tstate->next != NULL) {
Victor Stinner9e5d30c2020-03-07 00:54:20 +01001669 Py_FatalError("not the last thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001670 }
Nick Coghland6009512014-11-20 21:39:37 +10001671
Victor Stinner987a0dc2019-06-19 10:36:10 +02001672 _PyImport_Cleanup(tstate);
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001673 finalize_interp_clear(tstate);
1674 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001675}
1676
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001677/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001678
Victor Stinner331a6a52019-05-27 16:39:22 +02001679static PyStatus
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001680add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001681{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001682 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001683 m = PyImport_AddModule("__main__");
1684 if (m == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +02001685 return _PyStatus_ERR("can't create __main__ module");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001686
Nick Coghland6009512014-11-20 21:39:37 +10001687 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001688 ann_dict = PyDict_New();
1689 if ((ann_dict == NULL) ||
1690 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001691 return _PyStatus_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001692 }
1693 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001694
Nick Coghland6009512014-11-20 21:39:37 +10001695 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1696 PyObject *bimod = PyImport_ImportModule("builtins");
1697 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001698 return _PyStatus_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001699 }
1700 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001701 return _PyStatus_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001702 }
1703 Py_DECREF(bimod);
1704 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001705
Nick Coghland6009512014-11-20 21:39:37 +10001706 /* Main is a little special - imp.is_builtin("__main__") will return
1707 * False, but BuiltinImporter is still the most appropriate initial
1708 * setting for its __loader__ attribute. A more suitable value will
1709 * be set if __main__ gets further initialized later in the startup
1710 * process.
1711 */
1712 loader = PyDict_GetItemString(d, "__loader__");
1713 if (loader == NULL || loader == Py_None) {
1714 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1715 "BuiltinImporter");
1716 if (loader == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001717 return _PyStatus_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001718 }
1719 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001720 return _PyStatus_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001721 }
1722 Py_DECREF(loader);
1723 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001724 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001725}
1726
Nick Coghland6009512014-11-20 21:39:37 +10001727/* Import the site module (not into __main__ though) */
1728
Victor Stinner331a6a52019-05-27 16:39:22 +02001729static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001730init_import_site(void)
Nick Coghland6009512014-11-20 21:39:37 +10001731{
1732 PyObject *m;
1733 m = PyImport_ImportModule("site");
1734 if (m == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001735 return _PyStatus_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001736 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001737 Py_DECREF(m);
Victor Stinner331a6a52019-05-27 16:39:22 +02001738 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001739}
1740
Victor Stinner874dbe82015-09-04 17:29:57 +02001741/* Check if a file descriptor is valid or not.
1742 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1743static int
1744is_valid_fd(int fd)
1745{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001746/* dup() is faster than fstat(): fstat() can require input/output operations,
1747 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1748 startup. Problem: dup() doesn't check if the file descriptor is valid on
1749 some platforms.
1750
1751 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1752 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1753 EBADF. FreeBSD has similar issue (bpo-32849).
1754
1755 Only use dup() on platforms where dup() is enough to detect invalid FD in
1756 corner cases: on Linux and Windows (bpo-32849). */
1757#if defined(__linux__) || defined(MS_WINDOWS)
1758 if (fd < 0) {
1759 return 0;
1760 }
1761 int fd2;
1762
1763 _Py_BEGIN_SUPPRESS_IPH
1764 fd2 = dup(fd);
1765 if (fd2 >= 0) {
1766 close(fd2);
1767 }
1768 _Py_END_SUPPRESS_IPH
1769
1770 return (fd2 >= 0);
1771#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001772 struct stat st;
1773 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001774#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001775}
1776
1777/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001778static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02001779create_stdio(const PyConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001780 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001781 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001782{
1783 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1784 const char* mode;
1785 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001786 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001787 int buffering, isatty;
1788 _Py_IDENTIFIER(open);
1789 _Py_IDENTIFIER(isatty);
1790 _Py_IDENTIFIER(TextIOWrapper);
1791 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001792 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001793
Victor Stinner874dbe82015-09-04 17:29:57 +02001794 if (!is_valid_fd(fd))
1795 Py_RETURN_NONE;
1796
Nick Coghland6009512014-11-20 21:39:37 +10001797 /* stdin is always opened in buffered mode, first because it shouldn't
1798 make a difference in common use cases, second because TextIOWrapper
1799 depends on the presence of a read1() method which only exists on
1800 buffered streams.
1801 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001802 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001803 buffering = 0;
1804 else
1805 buffering = -1;
1806 if (write_mode)
1807 mode = "wb";
1808 else
1809 mode = "rb";
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001810 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOO",
Nick Coghland6009512014-11-20 21:39:37 +10001811 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001812 Py_None, Py_None, /* encoding, errors */
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001813 Py_None, Py_False); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001814 if (buf == NULL)
1815 goto error;
1816
1817 if (buffering) {
1818 _Py_IDENTIFIER(raw);
1819 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1820 if (raw == NULL)
1821 goto error;
1822 }
1823 else {
1824 raw = buf;
1825 Py_INCREF(raw);
1826 }
1827
Steve Dower39294992016-08-30 21:22:36 -07001828#ifdef MS_WINDOWS
1829 /* Windows console IO is always UTF-8 encoded */
1830 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001831 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001832#endif
1833
Nick Coghland6009512014-11-20 21:39:37 +10001834 text = PyUnicode_FromString(name);
1835 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1836 goto error;
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001837 res = _PyObject_CallMethodIdNoArgs(raw, &PyId_isatty);
Nick Coghland6009512014-11-20 21:39:37 +10001838 if (res == NULL)
1839 goto error;
1840 isatty = PyObject_IsTrue(res);
1841 Py_DECREF(res);
1842 if (isatty == -1)
1843 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001844 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001845 write_through = Py_True;
1846 else
1847 write_through = Py_False;
Jendrik Seipp5b907712020-01-01 23:21:43 +01001848 if (buffered_stdio && (isatty || fd == fileno(stderr)))
Nick Coghland6009512014-11-20 21:39:37 +10001849 line_buffering = Py_True;
1850 else
1851 line_buffering = Py_False;
1852
1853 Py_CLEAR(raw);
1854 Py_CLEAR(text);
1855
1856#ifdef MS_WINDOWS
1857 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1858 newlines to "\n".
1859 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1860 newline = NULL;
1861#else
1862 /* sys.stdin: split lines at "\n".
1863 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1864 newline = "\n";
1865#endif
1866
Victor Stinner709d23d2019-05-02 14:56:30 -04001867 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1868 if (encoding_str == NULL) {
1869 Py_CLEAR(buf);
1870 goto error;
1871 }
1872
1873 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1874 if (errors_str == NULL) {
1875 Py_CLEAR(buf);
1876 Py_CLEAR(encoding_str);
1877 goto error;
1878 }
1879
1880 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1881 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001882 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001883 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001884 Py_CLEAR(encoding_str);
1885 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001886 if (stream == NULL)
1887 goto error;
1888
1889 if (write_mode)
1890 mode = "w";
1891 else
1892 mode = "r";
1893 text = PyUnicode_FromString(mode);
1894 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1895 goto error;
1896 Py_CLEAR(text);
1897 return stream;
1898
1899error:
1900 Py_XDECREF(buf);
1901 Py_XDECREF(stream);
1902 Py_XDECREF(text);
1903 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001904
Victor Stinner874dbe82015-09-04 17:29:57 +02001905 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1906 /* Issue #24891: the file descriptor was closed after the first
1907 is_valid_fd() check was called. Ignore the OSError and set the
1908 stream to None. */
1909 PyErr_Clear();
1910 Py_RETURN_NONE;
1911 }
1912 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001913}
1914
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001915/* Set builtins.open to io.OpenWrapper */
1916static PyStatus
Andy Lester75cd5bf2020-03-12 02:49:05 -05001917init_set_builtins_open(void)
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001918{
1919 PyObject *iomod = NULL, *wrapper;
1920 PyObject *bimod = NULL;
1921 PyStatus res = _PyStatus_OK();
1922
1923 if (!(iomod = PyImport_ImportModule("io"))) {
1924 goto error;
1925 }
1926
1927 if (!(bimod = PyImport_ImportModule("builtins"))) {
1928 goto error;
1929 }
1930
1931 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1932 goto error;
1933 }
1934
1935 /* Set builtins.open */
1936 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1937 Py_DECREF(wrapper);
1938 goto error;
1939 }
1940 Py_DECREF(wrapper);
1941 goto done;
1942
1943error:
1944 res = _PyStatus_ERR("can't initialize io.open");
1945
1946done:
1947 Py_XDECREF(bimod);
1948 Py_XDECREF(iomod);
1949 return res;
1950}
1951
1952
Nick Coghland6009512014-11-20 21:39:37 +10001953/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinner331a6a52019-05-27 16:39:22 +02001954static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001955init_sys_streams(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10001956{
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001957 PyObject *iomod = NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001958 PyObject *m;
1959 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001960 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001961 PyObject * encoding_attr;
Victor Stinner331a6a52019-05-27 16:39:22 +02001962 PyStatus res = _PyStatus_OK();
Victor Stinnerda7933e2020-04-13 03:04:28 +02001963 const PyConfig *config = _PyInterpreterState_GetConfig(tstate->interp);
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001964
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001965 /* Check that stdin is not a directory
1966 Using shell redirection, you can redirect stdin to a directory,
1967 crashing the Python interpreter. Catch this common mistake here
1968 and output a useful error message. Note that under MS Windows,
1969 the shell already prevents that. */
1970#ifndef MS_WINDOWS
1971 struct _Py_stat_struct sb;
1972 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1973 S_ISDIR(sb.st_mode)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001974 return _PyStatus_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001975 }
1976#endif
1977
Nick Coghland6009512014-11-20 21:39:37 +10001978 /* Hack to avoid a nasty recursion issue when Python is invoked
1979 in verbose mode: pre-import the Latin-1 and UTF-8 codecs */
1980 if ((m = PyImport_ImportModule("encodings.utf_8")) == NULL) {
1981 goto error;
1982 }
1983 Py_DECREF(m);
1984
1985 if (!(m = PyImport_ImportModule("encodings.latin_1"))) {
1986 goto error;
1987 }
1988 Py_DECREF(m);
1989
Nick Coghland6009512014-11-20 21:39:37 +10001990 if (!(iomod = PyImport_ImportModule("io"))) {
1991 goto error;
1992 }
Nick Coghland6009512014-11-20 21:39:37 +10001993
Nick Coghland6009512014-11-20 21:39:37 +10001994 /* Set sys.stdin */
1995 fd = fileno(stdin);
1996 /* Under some conditions stdin, stdout and stderr may not be connected
1997 * and fileno() may point to an invalid file descriptor. For example
1998 * GUI apps don't have valid standard streams by default.
1999 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02002000 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02002001 config->stdio_encoding,
2002 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02002003 if (std == NULL)
2004 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10002005 PySys_SetObject("__stdin__", std);
2006 _PySys_SetObjectId(&PyId_stdin, std);
2007 Py_DECREF(std);
2008
2009 /* Set sys.stdout */
2010 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02002011 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02002012 config->stdio_encoding,
2013 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02002014 if (std == NULL)
2015 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10002016 PySys_SetObject("__stdout__", std);
2017 _PySys_SetObjectId(&PyId_stdout, std);
2018 Py_DECREF(std);
2019
2020#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
2021 /* Set sys.stderr, replaces the preliminary stderr */
2022 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02002023 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02002024 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04002025 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02002026 if (std == NULL)
2027 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10002028
2029 /* Same as hack above, pre-import stderr's codec to avoid recursion
2030 when import.c tries to write to stderr in verbose mode. */
2031 encoding_attr = PyObject_GetAttrString(std, "encoding");
2032 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02002033 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10002034 if (std_encoding != NULL) {
2035 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
2036 Py_XDECREF(codec_info);
2037 }
2038 Py_DECREF(encoding_attr);
2039 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02002040 _PyErr_Clear(tstate); /* Not a fatal error if codec isn't available */
Nick Coghland6009512014-11-20 21:39:37 +10002041
2042 if (PySys_SetObject("__stderr__", std) < 0) {
2043 Py_DECREF(std);
2044 goto error;
2045 }
2046 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
2047 Py_DECREF(std);
2048 goto error;
2049 }
2050 Py_DECREF(std);
2051#endif
2052
Victor Stinnera7368ac2017-11-15 18:11:45 -08002053 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10002054
Victor Stinnera7368ac2017-11-15 18:11:45 -08002055error:
Victor Stinner331a6a52019-05-27 16:39:22 +02002056 res = _PyStatus_ERR("can't initialize sys standard streams");
Victor Stinnera7368ac2017-11-15 18:11:45 -08002057
2058done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02002059 _Py_ClearStandardStreamEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10002060 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08002061 return res;
Nick Coghland6009512014-11-20 21:39:37 +10002062}
2063
2064
Victor Stinner10dc4842015-03-24 12:01:30 +01002065static void
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002066_Py_FatalError_DumpTracebacks(int fd, PyInterpreterState *interp,
2067 PyThreadState *tstate)
Victor Stinner10dc4842015-03-24 12:01:30 +01002068{
Victor Stinner10dc4842015-03-24 12:01:30 +01002069 fputc('\n', stderr);
2070 fflush(stderr);
2071
2072 /* display the current Python stack */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002073 _Py_DumpTracebackThreads(fd, interp, tstate);
Victor Stinner10dc4842015-03-24 12:01:30 +01002074}
Victor Stinner791da1c2016-03-14 16:53:12 +01002075
2076/* Print the current exception (if an exception is set) with its traceback,
2077 or display the current Python stack.
2078
2079 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
2080 called on catastrophic cases.
2081
2082 Return 1 if the traceback was displayed, 0 otherwise. */
2083
2084static int
Andy Lester75cd5bf2020-03-12 02:49:05 -05002085_Py_FatalError_PrintExc(PyThreadState *tstate)
Victor Stinner791da1c2016-03-14 16:53:12 +01002086{
2087 PyObject *ferr, *res;
2088 PyObject *exception, *v, *tb;
2089 int has_tb;
2090
Victor Stinnerb45d2592019-06-20 00:05:23 +02002091 _PyErr_Fetch(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002092 if (exception == NULL) {
2093 /* No current exception */
2094 return 0;
2095 }
2096
2097 ferr = _PySys_GetObjectId(&PyId_stderr);
2098 if (ferr == NULL || ferr == Py_None) {
2099 /* sys.stderr is not set yet or set to None,
2100 no need to try to display the exception */
2101 return 0;
2102 }
2103
Victor Stinnerb45d2592019-06-20 00:05:23 +02002104 _PyErr_NormalizeException(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002105 if (tb == NULL) {
2106 tb = Py_None;
2107 Py_INCREF(tb);
2108 }
2109 PyException_SetTraceback(v, tb);
2110 if (exception == NULL) {
2111 /* PyErr_NormalizeException() failed */
2112 return 0;
2113 }
2114
2115 has_tb = (tb != Py_None);
2116 PyErr_Display(exception, v, tb);
2117 Py_XDECREF(exception);
2118 Py_XDECREF(v);
2119 Py_XDECREF(tb);
2120
2121 /* sys.stderr may be buffered: call sys.stderr.flush() */
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002122 res = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002123 if (res == NULL) {
2124 _PyErr_Clear(tstate);
2125 }
2126 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002127 Py_DECREF(res);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002128 }
Victor Stinner791da1c2016-03-14 16:53:12 +01002129
2130 return has_tb;
2131}
2132
Nick Coghland6009512014-11-20 21:39:37 +10002133/* Print fatal error message and abort */
2134
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002135#ifdef MS_WINDOWS
2136static void
2137fatal_output_debug(const char *msg)
2138{
2139 /* buffer of 256 bytes allocated on the stack */
2140 WCHAR buffer[256 / sizeof(WCHAR)];
2141 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2142 size_t msglen;
2143
2144 OutputDebugStringW(L"Fatal Python error: ");
2145
2146 msglen = strlen(msg);
2147 while (msglen) {
2148 size_t i;
2149
2150 if (buflen > msglen) {
2151 buflen = msglen;
2152 }
2153
2154 /* Convert the message to wchar_t. This uses a simple one-to-one
2155 conversion, assuming that the this error message actually uses
2156 ASCII only. If this ceases to be true, we will have to convert. */
2157 for (i=0; i < buflen; ++i) {
2158 buffer[i] = msg[i];
2159 }
2160 buffer[i] = L'\0';
2161 OutputDebugStringW(buffer);
2162
2163 msg += buflen;
2164 msglen -= buflen;
2165 }
2166 OutputDebugStringW(L"\n");
2167}
2168#endif
2169
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002170
2171static void
2172fatal_error_dump_runtime(FILE *stream, _PyRuntimeState *runtime)
2173{
2174 fprintf(stream, "Python runtime state: ");
Victor Stinner7b3c2522020-03-07 00:24:23 +01002175 PyThreadState *finalizing = _PyRuntimeState_GetFinalizing(runtime);
2176 if (finalizing) {
2177 fprintf(stream, "finalizing (tstate=%p)", finalizing);
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002178 }
2179 else if (runtime->initialized) {
2180 fprintf(stream, "initialized");
2181 }
2182 else if (runtime->core_initialized) {
2183 fprintf(stream, "core initialized");
2184 }
2185 else if (runtime->preinitialized) {
2186 fprintf(stream, "preinitialized");
2187 }
2188 else if (runtime->preinitializing) {
2189 fprintf(stream, "preinitializing");
2190 }
2191 else {
2192 fprintf(stream, "unknown");
2193 }
2194 fprintf(stream, "\n");
2195 fflush(stream);
2196}
2197
2198
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002199static inline void _Py_NO_RETURN
2200fatal_error_exit(int status)
Nick Coghland6009512014-11-20 21:39:37 +10002201{
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002202 if (status < 0) {
2203#if defined(MS_WINDOWS) && defined(_DEBUG)
2204 DebugBreak();
2205#endif
2206 abort();
2207 }
2208 else {
2209 exit(status);
2210 }
2211}
2212
2213
2214static void _Py_NO_RETURN
2215fatal_error(FILE *stream, int header, const char *prefix, const char *msg,
2216 int status)
2217{
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002218 const int fd = fileno(stream);
Victor Stinner53345a42015-03-25 01:55:14 +01002219 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002220
2221 if (reentrant) {
2222 /* Py_FatalError() caused a second fatal error.
2223 Example: flush_std_files() raises a recursion error. */
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002224 fatal_error_exit(status);
Victor Stinner53345a42015-03-25 01:55:14 +01002225 }
2226 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002227
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002228 if (header) {
2229 fprintf(stream, "Fatal Python error: ");
2230 if (prefix) {
2231 fputs(prefix, stream);
2232 fputs(": ", stream);
2233 }
2234 if (msg) {
2235 fputs(msg, stream);
2236 }
2237 else {
2238 fprintf(stream, "<message not set>");
2239 }
2240 fputs("\n", stream);
2241 fflush(stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002242 }
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002243
2244 _PyRuntimeState *runtime = &_PyRuntime;
2245 fatal_error_dump_runtime(stream, runtime);
2246
2247 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
2248 PyInterpreterState *interp = NULL;
2249 if (tstate != NULL) {
2250 interp = tstate->interp;
2251 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002252
Victor Stinner3a228ab2018-11-01 00:26:41 +01002253 /* Check if the current thread has a Python thread state
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002254 and holds the GIL.
Victor Stinner3a228ab2018-11-01 00:26:41 +01002255
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002256 tss_tstate is NULL if Py_FatalError() is called from a C thread which
2257 has no Python thread state.
2258
2259 tss_tstate != tstate if the current Python thread does not hold the GIL.
2260 */
2261 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2262 int has_tstate_and_gil = (tss_tstate != NULL && tss_tstate == tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002263 if (has_tstate_and_gil) {
2264 /* If an exception is set, print the exception with its traceback */
Andy Lester75cd5bf2020-03-12 02:49:05 -05002265 if (!_Py_FatalError_PrintExc(tss_tstate)) {
Victor Stinner3a228ab2018-11-01 00:26:41 +01002266 /* No exception is set, or an exception is set without traceback */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002267 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002268 }
2269 }
2270 else {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002271 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002272 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002273
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002274 /* The main purpose of faulthandler is to display the traceback.
2275 This function already did its best to display a traceback.
2276 Disable faulthandler to prevent writing a second traceback
2277 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002278 _PyFaulthandler_Fini();
2279
Victor Stinner791da1c2016-03-14 16:53:12 +01002280 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002281 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002282 /* Flush sys.stdout and sys.stderr */
2283 flush_std_files();
2284 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002285
Nick Coghland6009512014-11-20 21:39:37 +10002286#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002287 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002288#endif /* MS_WINDOWS */
2289
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002290 fatal_error_exit(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002291}
2292
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002293
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002294#undef Py_FatalError
2295
Victor Stinner19760862017-12-20 01:41:59 +01002296void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002297Py_FatalError(const char *msg)
2298{
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002299 fatal_error(stderr, 1, NULL, msg, -1);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002300}
2301
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002302
Victor Stinner19760862017-12-20 01:41:59 +01002303void _Py_NO_RETURN
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002304_Py_FatalErrorFunc(const char *func, const char *msg)
2305{
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002306 fatal_error(stderr, 1, func, msg, -1);
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002307}
2308
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002309
2310void _Py_NO_RETURN
2311_Py_FatalErrorFormat(const char *func, const char *format, ...)
2312{
2313 static int reentrant = 0;
2314 if (reentrant) {
2315 /* _Py_FatalErrorFormat() caused a second fatal error */
2316 fatal_error_exit(-1);
2317 }
2318 reentrant = 1;
2319
2320 FILE *stream = stderr;
2321 fprintf(stream, "Fatal Python error: ");
2322 if (func) {
2323 fputs(func, stream);
2324 fputs(": ", stream);
2325 }
2326 fflush(stream);
2327
2328 va_list vargs;
2329#ifdef HAVE_STDARG_PROTOTYPES
2330 va_start(vargs, format);
2331#else
2332 va_start(vargs);
2333#endif
2334 vfprintf(stream, format, vargs);
2335 va_end(vargs);
2336
2337 fputs("\n", stream);
2338 fflush(stream);
2339
2340 fatal_error(stream, 0, NULL, NULL, -1);
2341}
2342
2343
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002344void _Py_NO_RETURN
Victor Stinner331a6a52019-05-27 16:39:22 +02002345Py_ExitStatusException(PyStatus status)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002346{
Victor Stinner331a6a52019-05-27 16:39:22 +02002347 if (_PyStatus_IS_EXIT(status)) {
2348 exit(status.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002349 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002350 else if (_PyStatus_IS_ERROR(status)) {
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002351 fatal_error(stderr, 1, status.func, status.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002352 }
2353 else {
Victor Stinner331a6a52019-05-27 16:39:22 +02002354 Py_FatalError("Py_ExitStatusException() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002355 }
Nick Coghland6009512014-11-20 21:39:37 +10002356}
2357
2358/* Clean up and exit */
2359
Nick Coghland6009512014-11-20 21:39:37 +10002360/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002361void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002362{
Victor Stinner81a7be32020-04-14 15:14:01 +02002363 PyInterpreterState *is = _PyInterpreterState_GET();
Marcel Plch776407f2017-12-20 11:17:58 +01002364
Antoine Pitroufc5db952017-12-13 02:29:07 +01002365 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002366 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2367
2368 is->pyexitfunc = func;
2369 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002370}
2371
2372static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002373call_py_exitfuncs(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002374{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002375 PyInterpreterState *interp = tstate->interp;
2376 if (interp->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002377 return;
2378
Victor Stinnerb45d2592019-06-20 00:05:23 +02002379 (*interp->pyexitfunc)(interp->pyexitmodule);
2380 _PyErr_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10002381}
2382
2383/* Wait until threading._shutdown completes, provided
2384 the threading module was imported in the first place.
2385 The shutdown routine will wait until all non-daemon
2386 "threading" threads have completed. */
2387static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002388wait_for_thread_shutdown(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002389{
Nick Coghland6009512014-11-20 21:39:37 +10002390 _Py_IDENTIFIER(_shutdown);
2391 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002392 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002393 if (threading == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +02002394 if (_PyErr_Occurred(tstate)) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002395 PyErr_WriteUnraisable(NULL);
2396 }
2397 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002398 return;
2399 }
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002400 result = _PyObject_CallMethodIdNoArgs(threading, &PyId__shutdown);
Nick Coghland6009512014-11-20 21:39:37 +10002401 if (result == NULL) {
2402 PyErr_WriteUnraisable(threading);
2403 }
2404 else {
2405 Py_DECREF(result);
2406 }
2407 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002408}
2409
2410#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002411int Py_AtExit(void (*func)(void))
2412{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002413 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002414 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002415 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002416 return 0;
2417}
2418
2419static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002420call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002421{
Victor Stinner8e91c242019-04-24 17:24:01 +02002422 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002423 /* pop last function from the list */
2424 runtime->nexitfuncs--;
2425 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2426 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2427
2428 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002429 }
Nick Coghland6009512014-11-20 21:39:37 +10002430
2431 fflush(stdout);
2432 fflush(stderr);
2433}
2434
Victor Stinnercfc88312018-08-01 16:41:25 +02002435void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002436Py_Exit(int sts)
2437{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002438 if (Py_FinalizeEx() < 0) {
2439 sts = 120;
2440 }
Nick Coghland6009512014-11-20 21:39:37 +10002441
2442 exit(sts);
2443}
2444
Victor Stinner331a6a52019-05-27 16:39:22 +02002445static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02002446init_signals(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002447{
2448#ifdef SIGPIPE
2449 PyOS_setsig(SIGPIPE, SIG_IGN);
2450#endif
2451#ifdef SIGXFZ
2452 PyOS_setsig(SIGXFZ, SIG_IGN);
2453#endif
2454#ifdef SIGXFSZ
2455 PyOS_setsig(SIGXFSZ, SIG_IGN);
2456#endif
Victor Stinner400e1db2020-03-31 19:13:10 +02002457 PyOS_InitInterrupts(); /* May imply init_signals() */
Victor Stinnerb45d2592019-06-20 00:05:23 +02002458 if (_PyErr_Occurred(tstate)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002459 return _PyStatus_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002460 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002461 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002462}
2463
2464
2465/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2466 *
2467 * All of the code in this function must only use async-signal-safe functions,
2468 * listed at `man 7 signal` or
2469 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
Victor Stinnerefc28bb2020-03-05 18:13:56 +01002470 *
2471 * If this function is updated, update also _posix_spawn() of subprocess.py.
Nick Coghland6009512014-11-20 21:39:37 +10002472 */
2473void
2474_Py_RestoreSignals(void)
2475{
2476#ifdef SIGPIPE
2477 PyOS_setsig(SIGPIPE, SIG_DFL);
2478#endif
2479#ifdef SIGXFZ
2480 PyOS_setsig(SIGXFZ, SIG_DFL);
2481#endif
2482#ifdef SIGXFSZ
2483 PyOS_setsig(SIGXFSZ, SIG_DFL);
2484#endif
2485}
2486
2487
2488/*
2489 * The file descriptor fd is considered ``interactive'' if either
2490 * a) isatty(fd) is TRUE, or
2491 * b) the -i flag was given, and the filename associated with
2492 * the descriptor is NULL or "<stdin>" or "???".
2493 */
2494int
2495Py_FdIsInteractive(FILE *fp, const char *filename)
2496{
2497 if (isatty((int)fileno(fp)))
2498 return 1;
2499 if (!Py_InteractiveFlag)
2500 return 0;
2501 return (filename == NULL) ||
2502 (strcmp(filename, "<stdin>") == 0) ||
2503 (strcmp(filename, "???") == 0);
2504}
2505
2506
Nick Coghland6009512014-11-20 21:39:37 +10002507/* Wrappers around sigaction() or signal(). */
2508
2509PyOS_sighandler_t
2510PyOS_getsig(int sig)
2511{
2512#ifdef HAVE_SIGACTION
2513 struct sigaction context;
2514 if (sigaction(sig, NULL, &context) == -1)
2515 return SIG_ERR;
2516 return context.sa_handler;
2517#else
2518 PyOS_sighandler_t handler;
2519/* Special signal handling for the secure CRT in Visual Studio 2005 */
2520#if defined(_MSC_VER) && _MSC_VER >= 1400
2521 switch (sig) {
2522 /* Only these signals are valid */
2523 case SIGINT:
2524 case SIGILL:
2525 case SIGFPE:
2526 case SIGSEGV:
2527 case SIGTERM:
2528 case SIGBREAK:
2529 case SIGABRT:
2530 break;
2531 /* Don't call signal() with other values or it will assert */
2532 default:
2533 return SIG_ERR;
2534 }
2535#endif /* _MSC_VER && _MSC_VER >= 1400 */
2536 handler = signal(sig, SIG_IGN);
2537 if (handler != SIG_ERR)
2538 signal(sig, handler);
2539 return handler;
2540#endif
2541}
2542
2543/*
2544 * All of the code in this function must only use async-signal-safe functions,
2545 * listed at `man 7 signal` or
2546 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2547 */
2548PyOS_sighandler_t
2549PyOS_setsig(int sig, PyOS_sighandler_t handler)
2550{
2551#ifdef HAVE_SIGACTION
2552 /* Some code in Modules/signalmodule.c depends on sigaction() being
2553 * used here if HAVE_SIGACTION is defined. Fix that if this code
2554 * changes to invalidate that assumption.
2555 */
2556 struct sigaction context, ocontext;
2557 context.sa_handler = handler;
2558 sigemptyset(&context.sa_mask);
2559 context.sa_flags = 0;
2560 if (sigaction(sig, &context, &ocontext) == -1)
2561 return SIG_ERR;
2562 return ocontext.sa_handler;
2563#else
2564 PyOS_sighandler_t oldhandler;
2565 oldhandler = signal(sig, handler);
2566#ifdef HAVE_SIGINTERRUPT
2567 siginterrupt(sig, 1);
2568#endif
2569 return oldhandler;
2570#endif
2571}
2572
2573#ifdef __cplusplus
2574}
2575#endif