blob: 5726a559cfcb7399a13bb9d4cae13be0c3024747 [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 Stinner331a6a52019-05-27 16:39:22 +0200463 _PyConfig_Write(config, runtime);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200464
Victor Stinnerda7933e2020-04-13 03:04:28 +0200465 status = _PyInterpreterState_SetConfig(interp, config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200466 if (_PyStatus_EXCEPTION(status)) {
467 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200468 }
Victor Stinnerda7933e2020-04-13 03:04:28 +0200469 config = _PyInterpreterState_GetConfig(interp);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200470
Victor Stinner331a6a52019-05-27 16:39:22 +0200471 if (config->_install_importlib) {
Victor Stinner12f2f172019-09-26 15:51:50 +0200472 status = _PyConfig_WritePathConfig(config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200473 if (_PyStatus_EXCEPTION(status)) {
474 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200475 }
476 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200477 return _PyStatus_OK();
Victor Stinner1dc6e392018-07-25 02:49:17 +0200478}
479
480
Victor Stinner331a6a52019-05-27 16:39:22 +0200481static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200482pycore_init_runtime(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200483 const PyConfig *config)
Nick Coghland6009512014-11-20 21:39:37 +1000484{
Victor Stinner43125222019-04-24 18:23:53 +0200485 if (runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200486 return _PyStatus_ERR("main interpreter already initialized");
Victor Stinner1dc6e392018-07-25 02:49:17 +0200487 }
Victor Stinnerda273412017-12-15 01:46:02 +0100488
Victor Stinner331a6a52019-05-27 16:39:22 +0200489 _PyConfig_Write(config, runtime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600490
Eric Snow1abcf672017-05-23 21:46:51 -0700491 /* Py_Finalize leaves _Py_Finalizing set in order to help daemon
492 * threads behave a little more gracefully at interpreter shutdown.
493 * We clobber it here so the new interpreter can start with a clean
494 * slate.
495 *
496 * However, this may still lead to misbehaviour if there are daemon
497 * threads still hanging around from a previous Py_Initialize/Finalize
498 * pair :(
499 */
Victor Stinner7b3c2522020-03-07 00:24:23 +0100500 _PyRuntimeState_SetFinalizing(runtime, NULL);
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600501
Victor Stinner331a6a52019-05-27 16:39:22 +0200502 PyStatus status = _Py_HashRandomization_Init(config);
503 if (_PyStatus_EXCEPTION(status)) {
504 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800505 }
506
Victor Stinner331a6a52019-05-27 16:39:22 +0200507 status = _PyInterpreterState_Enable(runtime);
508 if (_PyStatus_EXCEPTION(status)) {
509 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -0800510 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200511 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100512}
Victor Stinnera7368ac2017-11-15 18:11:45 -0800513
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100514
Victor Stinner331a6a52019-05-27 16:39:22 +0200515static PyStatus
Victor Stinnerdda5d6e2020-04-08 17:54:59 +0200516init_interp_create_gil(PyThreadState *tstate)
517{
518 PyStatus status;
519
520 /* finalize_interp_delete() comment explains why _PyEval_FiniGIL() is
521 only called here. */
522 _PyEval_FiniGIL(tstate);
523
524 /* Auto-thread-state API */
525 status = _PyGILState_Init(tstate);
526 if (_PyStatus_EXCEPTION(status)) {
527 return status;
528 }
529
530 /* Create the GIL and take it */
531 status = _PyEval_InitGIL(tstate);
532 if (_PyStatus_EXCEPTION(status)) {
533 return status;
534 }
535
536 return _PyStatus_OK();
537}
538
539
540static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200541pycore_create_interpreter(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200542 const PyConfig *config,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200543 PyThreadState **tstate_p)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100544{
545 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnerda273412017-12-15 01:46:02 +0100546 if (interp == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200547 return _PyStatus_ERR("can't make main interpreter");
Victor Stinnerda273412017-12-15 01:46:02 +0100548 }
549
Victor Stinnerda7933e2020-04-13 03:04:28 +0200550 PyStatus status = _PyInterpreterState_SetConfig(interp, config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200551 if (_PyStatus_EXCEPTION(status)) {
552 return status;
Victor Stinnerda273412017-12-15 01:46:02 +0100553 }
Nick Coghland6009512014-11-20 21:39:37 +1000554
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200555 PyThreadState *tstate = PyThreadState_New(interp);
Victor Stinnerb45d2592019-06-20 00:05:23 +0200556 if (tstate == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200557 return _PyStatus_ERR("can't make first thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +0200558 }
Nick Coghland6009512014-11-20 21:39:37 +1000559 (void) PyThreadState_Swap(tstate);
560
Victor Stinnerdda5d6e2020-04-08 17:54:59 +0200561 status = init_interp_create_gil(tstate);
Victor Stinner111e4ee2020-03-09 21:24:14 +0100562 if (_PyStatus_EXCEPTION(status)) {
563 return status;
564 }
Victor Stinner2914bb32018-01-29 11:57:45 +0100565
Victor Stinnerb45d2592019-06-20 00:05:23 +0200566 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +0200567 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100568}
Nick Coghland6009512014-11-20 21:39:37 +1000569
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100570
Victor Stinner331a6a52019-05-27 16:39:22 +0200571static PyStatus
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100572pycore_init_types(PyThreadState *tstate)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100573{
Victor Stinner444b39b2019-11-20 01:18:11 +0100574 PyStatus status;
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100575 int is_main_interp = _Py_IsMainInterpreter(tstate);
Victor Stinner444b39b2019-11-20 01:18:11 +0100576
Victor Stinner01b1cc12019-11-20 02:27:56 +0100577 status = _PyGC_Init(tstate);
Victor Stinner444b39b2019-11-20 01:18:11 +0100578 if (_PyStatus_EXCEPTION(status)) {
579 return status;
580 }
581
Victor Stinnere7e699e2019-11-20 12:08:13 +0100582 if (is_main_interp) {
583 status = _PyTypes_Init();
584 if (_PyStatus_EXCEPTION(status)) {
585 return status;
586 }
Victor Stinner630c8df2019-12-17 13:02:18 +0100587 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100588
Victor Stinner630c8df2019-12-17 13:02:18 +0100589
590 if (!_PyLong_Init(tstate)) {
591 return _PyStatus_ERR("can't init longs");
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100592 }
Victor Stinneref5aa9a2019-11-20 00:38:03 +0100593
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100594 if (is_main_interp) {
Victor Stinnere7e699e2019-11-20 12:08:13 +0100595 status = _PyUnicode_Init();
596 if (_PyStatus_EXCEPTION(status)) {
597 return status;
598 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100599 }
600
Victor Stinner331a6a52019-05-27 16:39:22 +0200601 status = _PyExc_Init();
602 if (_PyStatus_EXCEPTION(status)) {
603 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100604 }
605
Victor Stinnere7e699e2019-11-20 12:08:13 +0100606 if (is_main_interp) {
607 if (!_PyFloat_Init()) {
608 return _PyStatus_ERR("can't init float");
609 }
Nick Coghland6009512014-11-20 21:39:37 +1000610
Victor Stinnere7e699e2019-11-20 12:08:13 +0100611 if (_PyStructSequence_Init() < 0) {
612 return _PyStatus_ERR("can't initialize structseq");
613 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100614 }
Victor Stinneref9d9b62019-05-22 11:28:22 +0200615
Victor Stinner331a6a52019-05-27 16:39:22 +0200616 status = _PyErr_Init();
617 if (_PyStatus_EXCEPTION(status)) {
618 return status;
Victor Stinneref9d9b62019-05-22 11:28:22 +0200619 }
620
Victor Stinnere7e699e2019-11-20 12:08:13 +0100621 if (is_main_interp) {
622 if (!_PyContext_Init()) {
623 return _PyStatus_ERR("can't init context");
624 }
Victor Stinneref5aa9a2019-11-20 00:38:03 +0100625 }
626
Victor Stinner331a6a52019-05-27 16:39:22 +0200627 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100628}
629
630
Victor Stinner331a6a52019-05-27 16:39:22 +0200631static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200632pycore_init_builtins(PyThreadState *tstate)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100633{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100634 assert(!_PyErr_Occurred(tstate));
635
Victor Stinnerb45d2592019-06-20 00:05:23 +0200636 PyObject *bimod = _PyBuiltin_Init(tstate);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100637 if (bimod == NULL) {
Victor Stinner2582d462019-11-22 19:24:49 +0100638 goto error;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100639 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100640
Victor Stinner2582d462019-11-22 19:24:49 +0100641 PyInterpreterState *interp = tstate->interp;
642 if (_PyImport_FixupBuiltin(bimod, "builtins", interp->modules) < 0) {
643 goto error;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100644 }
Victor Stinner2582d462019-11-22 19:24:49 +0100645
646 PyObject *builtins_dict = PyModule_GetDict(bimod);
647 if (builtins_dict == NULL) {
648 goto error;
649 }
650 Py_INCREF(builtins_dict);
651 interp->builtins = builtins_dict;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100652
Victor Stinner331a6a52019-05-27 16:39:22 +0200653 PyStatus status = _PyBuiltins_AddExceptions(bimod);
654 if (_PyStatus_EXCEPTION(status)) {
655 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100656 }
Victor Stinner2582d462019-11-22 19:24:49 +0100657
658 interp->builtins_copy = PyDict_Copy(interp->builtins);
659 if (interp->builtins_copy == NULL) {
660 goto error;
661 }
Pablo Galindob96c6b02019-12-04 11:19:59 +0000662 Py_DECREF(bimod);
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100663
664 assert(!_PyErr_Occurred(tstate));
665
Victor Stinner331a6a52019-05-27 16:39:22 +0200666 return _PyStatus_OK();
Victor Stinner2582d462019-11-22 19:24:49 +0100667
668error:
Pablo Galindob96c6b02019-12-04 11:19:59 +0000669 Py_XDECREF(bimod);
Victor Stinner2582d462019-11-22 19:24:49 +0100670 return _PyStatus_ERR("can't initialize builtins module");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100671}
672
673
Victor Stinner331a6a52019-05-27 16:39:22 +0200674static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200675pycore_init_import_warnings(PyThreadState *tstate, PyObject *sysmod)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100676{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100677 assert(!_PyErr_Occurred(tstate));
Victor Stinnerb45d2592019-06-20 00:05:23 +0200678
Victor Stinner2582d462019-11-22 19:24:49 +0100679 PyStatus status = _PyImportHooks_Init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200680 if (_PyStatus_EXCEPTION(status)) {
681 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800682 }
Nick Coghland6009512014-11-20 21:39:37 +1000683
Victor Stinnerda7933e2020-04-13 03:04:28 +0200684 const PyConfig *config = _PyInterpreterState_GetConfig(tstate->interp);
Victor Stinner2ec1a1b2019-11-22 21:54:33 +0100685 if (_Py_IsMainInterpreter(tstate)) {
686 /* Initialize _warnings. */
Victor Stinner66b79732020-03-02 15:02:18 +0100687 status = _PyWarnings_InitState(tstate);
688 if (_PyStatus_EXCEPTION(status)) {
689 return status;
Victor Stinner2ec1a1b2019-11-22 21:54:33 +0100690 }
Nick Coghland6009512014-11-20 21:39:37 +1000691
Victor Stinner2ec1a1b2019-11-22 21:54:33 +0100692 if (config->_install_importlib) {
693 status = _PyConfig_WritePathConfig(config);
694 if (_PyStatus_EXCEPTION(status)) {
695 return status;
696 }
Victor Stinnerb1147e42018-07-21 02:06:16 +0200697 }
698 }
699
Eric Snow1abcf672017-05-23 21:46:51 -0700700 /* This call sets up builtin and frozen import support */
Victor Stinnerb45d2592019-06-20 00:05:23 +0200701 if (config->_install_importlib) {
702 status = init_importlib(tstate, sysmod);
Victor Stinner331a6a52019-05-27 16:39:22 +0200703 if (_PyStatus_EXCEPTION(status)) {
704 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800705 }
Eric Snow1abcf672017-05-23 21:46:51 -0700706 }
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100707
708 assert(!_PyErr_Occurred(tstate));
709
Victor Stinner331a6a52019-05-27 16:39:22 +0200710 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100711}
712
713
Victor Stinner331a6a52019-05-27 16:39:22 +0200714static PyStatus
Victor Stinnerd863ade2019-12-06 03:37:07 +0100715pycore_interp_init(PyThreadState *tstate)
716{
717 PyStatus status;
Victor Stinner080ee5a2019-12-08 21:55:58 +0100718 PyObject *sysmod = NULL;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100719
720 status = pycore_init_types(tstate);
721 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100722 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100723 }
724
Victor Stinnerd863ade2019-12-06 03:37:07 +0100725 status = _PySys_Create(tstate, &sysmod);
726 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100727 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100728 }
729
730 status = pycore_init_builtins(tstate);
731 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100732 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100733 }
734
Victor Stinner080ee5a2019-12-08 21:55:58 +0100735 status = pycore_init_import_warnings(tstate, sysmod);
736
737done:
738 /* sys.modules['sys'] contains a strong reference to the module */
739 Py_XDECREF(sysmod);
740 return status;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100741}
742
743
744static PyStatus
Victor Stinner331a6a52019-05-27 16:39:22 +0200745pyinit_config(_PyRuntimeState *runtime,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200746 PyThreadState **tstate_p,
Victor Stinner331a6a52019-05-27 16:39:22 +0200747 const PyConfig *config)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100748{
Victor Stinner331a6a52019-05-27 16:39:22 +0200749 _PyConfig_Write(config, runtime);
Victor Stinner20004952019-03-26 02:31:11 +0100750
Victor Stinner331a6a52019-05-27 16:39:22 +0200751 PyStatus status = pycore_init_runtime(runtime, config);
752 if (_PyStatus_EXCEPTION(status)) {
753 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100754 }
755
Victor Stinnerb45d2592019-06-20 00:05:23 +0200756 PyThreadState *tstate;
757 status = pycore_create_interpreter(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200758 if (_PyStatus_EXCEPTION(status)) {
759 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100760 }
Victor Stinnerb45d2592019-06-20 00:05:23 +0200761 *tstate_p = tstate;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100762
Victor Stinnerd863ade2019-12-06 03:37:07 +0100763 status = pycore_interp_init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200764 if (_PyStatus_EXCEPTION(status)) {
765 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100766 }
Eric Snow1abcf672017-05-23 21:46:51 -0700767
768 /* Only when we get here is the runtime core fully initialized */
Victor Stinner43125222019-04-24 18:23:53 +0200769 runtime->core_initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200770 return _PyStatus_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700771}
772
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100773
Victor Stinner331a6a52019-05-27 16:39:22 +0200774PyStatus
775_Py_PreInitializeFromPyArgv(const PyPreConfig *src_config, const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100776{
Victor Stinner331a6a52019-05-27 16:39:22 +0200777 PyStatus status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100778
Victor Stinner6d1c4672019-05-20 11:02:00 +0200779 if (src_config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200780 return _PyStatus_ERR("preinitialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +0200781 }
782
Victor Stinner331a6a52019-05-27 16:39:22 +0200783 status = _PyRuntime_Initialize();
784 if (_PyStatus_EXCEPTION(status)) {
785 return status;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100786 }
Victor Stinner43125222019-04-24 18:23:53 +0200787 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100788
Victor Stinnerd3b90412019-09-17 23:59:51 +0200789 if (runtime->preinitialized) {
Victor Stinnerf72346c2019-03-25 17:54:58 +0100790 /* If it's already configured: ignored the new configuration */
Victor Stinner331a6a52019-05-27 16:39:22 +0200791 return _PyStatus_OK();
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100792 }
793
Victor Stinnerd3b90412019-09-17 23:59:51 +0200794 /* Note: preinitialized remains 1 on error, it is only set to 0
795 at exit on success. */
796 runtime->preinitializing = 1;
797
Victor Stinner331a6a52019-05-27 16:39:22 +0200798 PyPreConfig config;
Victor Stinner441b10c2019-09-28 04:28:35 +0200799
800 status = _PyPreConfig_InitFromPreConfig(&config, src_config);
801 if (_PyStatus_EXCEPTION(status)) {
802 return status;
803 }
Victor Stinnerf72346c2019-03-25 17:54:58 +0100804
Victor Stinner331a6a52019-05-27 16:39:22 +0200805 status = _PyPreConfig_Read(&config, args);
806 if (_PyStatus_EXCEPTION(status)) {
807 return status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100808 }
809
Victor Stinner331a6a52019-05-27 16:39:22 +0200810 status = _PyPreConfig_Write(&config);
811 if (_PyStatus_EXCEPTION(status)) {
812 return status;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100813 }
814
Victor Stinnerd3b90412019-09-17 23:59:51 +0200815 runtime->preinitializing = 0;
816 runtime->preinitialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200817 return _PyStatus_OK();
Victor Stinnerf72346c2019-03-25 17:54:58 +0100818}
819
Victor Stinner70005ac2019-05-02 15:25:34 -0400820
Victor Stinner331a6a52019-05-27 16:39:22 +0200821PyStatus
822Py_PreInitializeFromBytesArgs(const PyPreConfig *src_config, Py_ssize_t argc, char **argv)
Victor Stinnerf72346c2019-03-25 17:54:58 +0100823{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100824 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400825 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100826}
827
828
Victor Stinner331a6a52019-05-27 16:39:22 +0200829PyStatus
830Py_PreInitializeFromArgs(const PyPreConfig *src_config, Py_ssize_t argc, wchar_t **argv)
Victor Stinner20004952019-03-26 02:31:11 +0100831{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100832 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400833 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinner20004952019-03-26 02:31:11 +0100834}
835
836
Victor Stinner331a6a52019-05-27 16:39:22 +0200837PyStatus
838Py_PreInitialize(const PyPreConfig *src_config)
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100839{
Victor Stinner70005ac2019-05-02 15:25:34 -0400840 return _Py_PreInitializeFromPyArgv(src_config, NULL);
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100841}
842
843
Victor Stinner331a6a52019-05-27 16:39:22 +0200844PyStatus
845_Py_PreInitializeFromConfig(const PyConfig *config,
846 const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100847{
Victor Stinner331a6a52019-05-27 16:39:22 +0200848 assert(config != NULL);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200849
Victor Stinner331a6a52019-05-27 16:39:22 +0200850 PyStatus status = _PyRuntime_Initialize();
851 if (_PyStatus_EXCEPTION(status)) {
852 return status;
Victor Stinner6d1c4672019-05-20 11:02:00 +0200853 }
854 _PyRuntimeState *runtime = &_PyRuntime;
855
Victor Stinnerd3b90412019-09-17 23:59:51 +0200856 if (runtime->preinitialized) {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200857 /* Already initialized: do nothing */
Victor Stinner331a6a52019-05-27 16:39:22 +0200858 return _PyStatus_OK();
Victor Stinner70005ac2019-05-02 15:25:34 -0400859 }
Victor Stinnercab5d072019-05-17 19:01:14 +0200860
Victor Stinner331a6a52019-05-27 16:39:22 +0200861 PyPreConfig preconfig;
Victor Stinner441b10c2019-09-28 04:28:35 +0200862
Victor Stinner3c30a762019-10-01 10:56:37 +0200863 _PyPreConfig_InitFromConfig(&preconfig, config);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200864
Victor Stinner331a6a52019-05-27 16:39:22 +0200865 if (!config->parse_argv) {
866 return Py_PreInitialize(&preconfig);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200867 }
868 else if (args == NULL) {
Victor Stinnercab5d072019-05-17 19:01:14 +0200869 _PyArgv config_args = {
870 .use_bytes_argv = 0,
Victor Stinner331a6a52019-05-27 16:39:22 +0200871 .argc = config->argv.length,
872 .wchar_argv = config->argv.items};
Victor Stinner6d1c4672019-05-20 11:02:00 +0200873 return _Py_PreInitializeFromPyArgv(&preconfig, &config_args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200874 }
875 else {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200876 return _Py_PreInitializeFromPyArgv(&preconfig, args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200877 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100878}
879
880
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100881/* Begin interpreter initialization
882 *
883 * On return, the first thread and interpreter state have been created,
884 * but the compiler, signal handling, multithreading and
885 * multiple interpreter support, and codec infrastructure are not yet
886 * available.
887 *
888 * The import system will support builtin and frozen modules only.
889 * The only supported io is writing to sys.stderr
890 *
891 * If any operation invoked by this function fails, a fatal error is
892 * issued and the function does not return.
893 *
894 * Any code invoked from this function should *not* assume it has access
895 * to the Python C API (unless the API is explicitly listed as being
896 * safe to call without calling Py_Initialize first)
897 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200898static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200899pyinit_core(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200900 const PyConfig *src_config,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200901 PyThreadState **tstate_p)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200902{
Victor Stinner331a6a52019-05-27 16:39:22 +0200903 PyStatus status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200904
Victor Stinner331a6a52019-05-27 16:39:22 +0200905 status = _Py_PreInitializeFromConfig(src_config, NULL);
906 if (_PyStatus_EXCEPTION(status)) {
907 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200908 }
909
Victor Stinner331a6a52019-05-27 16:39:22 +0200910 PyConfig config;
Victor Stinner8462a492019-10-01 12:06:16 +0200911 _PyConfig_InitCompatConfig(&config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200912
Victor Stinner331a6a52019-05-27 16:39:22 +0200913 status = _PyConfig_Copy(&config, src_config);
914 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200915 goto done;
916 }
917
Victor Stinner331a6a52019-05-27 16:39:22 +0200918 status = PyConfig_Read(&config);
919 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200920 goto done;
921 }
922
923 if (!runtime->core_initialized) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200924 status = pyinit_config(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200925 }
926 else {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200927 status = pyinit_core_reconfigure(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200928 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200929 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200930 goto done;
931 }
932
933done:
Victor Stinner331a6a52019-05-27 16:39:22 +0200934 PyConfig_Clear(&config);
935 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200936}
937
Victor Stinner5ac27a52019-03-27 13:40:14 +0100938
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200939/* Py_Initialize() has already been called: update the main interpreter
940 configuration. Example of bpo-34008: Py_Main() called after
941 Py_Initialize(). */
Victor Stinner331a6a52019-05-27 16:39:22 +0200942static PyStatus
Victor Stinnerb0051362019-11-22 17:52:42 +0100943_Py_ReconfigureMainInterpreter(PyThreadState *tstate)
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200944{
Victor Stinnerda7933e2020-04-13 03:04:28 +0200945 const PyConfig *config = _PyInterpreterState_GetConfig(tstate->interp);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100946
Victor Stinner331a6a52019-05-27 16:39:22 +0200947 PyObject *argv = _PyWideStringList_AsList(&config->argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100948 if (argv == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200949 return _PyStatus_NO_MEMORY(); \
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100950 }
951
Victor Stinnerb0051362019-11-22 17:52:42 +0100952 int res = PyDict_SetItemString(tstate->interp->sysdict, "argv", argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100953 Py_DECREF(argv);
954 if (res < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200955 return _PyStatus_ERR("fail to set sys.argv");
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200956 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200957 return _PyStatus_OK();
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200958}
959
Victor Stinnerb0051362019-11-22 17:52:42 +0100960
961static PyStatus
962init_interp_main(PyThreadState *tstate)
963{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100964 assert(!_PyErr_Occurred(tstate));
965
Victor Stinnerb0051362019-11-22 17:52:42 +0100966 PyStatus status;
967 int is_main_interp = _Py_IsMainInterpreter(tstate);
968 PyInterpreterState *interp = tstate->interp;
Victor Stinnerda7933e2020-04-13 03:04:28 +0200969 const PyConfig *config = _PyInterpreterState_GetConfig(interp);
Victor Stinnerb0051362019-11-22 17:52:42 +0100970
971 if (!config->_install_importlib) {
972 /* Special mode for freeze_importlib: run with no import system
973 *
974 * This means anything which needs support from extension modules
975 * or pure Python code in the standard library won't work.
976 */
977 if (is_main_interp) {
978 interp->runtime->initialized = 1;
979 }
980 return _PyStatus_OK();
981 }
982
983 if (is_main_interp) {
984 if (_PyTime_Init() < 0) {
985 return _PyStatus_ERR("can't initialize time");
986 }
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100987 }
Victor Stinnerb0051362019-11-22 17:52:42 +0100988
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100989 if (_PySys_InitMain(tstate) < 0) {
990 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerb0051362019-11-22 17:52:42 +0100991 }
992
993 status = init_importlib_external(tstate);
994 if (_PyStatus_EXCEPTION(status)) {
995 return status;
996 }
997
998 if (is_main_interp) {
999 /* initialize the faulthandler module */
1000 status = _PyFaulthandler_Init(config->faulthandler);
1001 if (_PyStatus_EXCEPTION(status)) {
1002 return status;
1003 }
1004 }
1005
1006 status = _PyUnicode_InitEncodings(tstate);
1007 if (_PyStatus_EXCEPTION(status)) {
1008 return status;
1009 }
1010
1011 if (is_main_interp) {
1012 if (config->install_signal_handlers) {
1013 status = init_signals(tstate);
1014 if (_PyStatus_EXCEPTION(status)) {
1015 return status;
1016 }
1017 }
1018
1019 if (_PyTraceMalloc_Init(config->tracemalloc) < 0) {
1020 return _PyStatus_ERR("can't initialize tracemalloc");
1021 }
1022 }
1023
1024 status = init_sys_streams(tstate);
1025 if (_PyStatus_EXCEPTION(status)) {
1026 return status;
1027 }
1028
Andy Lester75cd5bf2020-03-12 02:49:05 -05001029 status = init_set_builtins_open();
Victor Stinnerb0051362019-11-22 17:52:42 +01001030 if (_PyStatus_EXCEPTION(status)) {
1031 return status;
1032 }
1033
1034 status = add_main_module(interp);
1035 if (_PyStatus_EXCEPTION(status)) {
1036 return status;
1037 }
1038
1039 if (is_main_interp) {
1040 /* Initialize warnings. */
1041 PyObject *warnoptions = PySys_GetObject("warnoptions");
1042 if (warnoptions != NULL && PyList_Size(warnoptions) > 0)
1043 {
1044 PyObject *warnings_module = PyImport_ImportModule("warnings");
1045 if (warnings_module == NULL) {
1046 fprintf(stderr, "'import warnings' failed; traceback:\n");
1047 _PyErr_Print(tstate);
1048 }
1049 Py_XDECREF(warnings_module);
1050 }
1051
1052 interp->runtime->initialized = 1;
1053 }
1054
1055 if (config->site_import) {
1056 status = init_import_site();
1057 if (_PyStatus_EXCEPTION(status)) {
1058 return status;
1059 }
1060 }
1061
1062 if (is_main_interp) {
1063#ifndef MS_WINDOWS
1064 emit_stderr_warning_for_legacy_locale(interp->runtime);
1065#endif
1066 }
1067
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001068 assert(!_PyErr_Occurred(tstate));
1069
Victor Stinnerb0051362019-11-22 17:52:42 +01001070 return _PyStatus_OK();
1071}
1072
1073
Eric Snowc7ec9982017-05-23 23:00:52 -07001074/* Update interpreter state based on supplied configuration settings
1075 *
1076 * After calling this function, most of the restrictions on the interpreter
1077 * are lifted. The only remaining incomplete settings are those related
1078 * to the main module (sys.argv[0], __main__ metadata)
1079 *
1080 * Calling this when the interpreter is not initializing, is already
1081 * initialized or without a valid current thread state is a fatal error.
1082 * Other errors should be reported as normal Python exceptions with a
1083 * non-zero return code.
1084 */
Victor Stinner331a6a52019-05-27 16:39:22 +02001085static PyStatus
Victor Stinner01b1cc12019-11-20 02:27:56 +01001086pyinit_main(PyThreadState *tstate)
Eric Snow1abcf672017-05-23 21:46:51 -07001087{
Victor Stinnerb0051362019-11-22 17:52:42 +01001088 PyInterpreterState *interp = tstate->interp;
1089 if (!interp->runtime->core_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001090 return _PyStatus_ERR("runtime core not initialized");
Eric Snowc7ec9982017-05-23 23:00:52 -07001091 }
Eric Snowc7ec9982017-05-23 23:00:52 -07001092
Victor Stinnerb0051362019-11-22 17:52:42 +01001093 if (interp->runtime->initialized) {
1094 return _Py_ReconfigureMainInterpreter(tstate);
Victor Stinnerfb47bca2018-07-20 17:34:23 +02001095 }
1096
Victor Stinnerb0051362019-11-22 17:52:42 +01001097 PyStatus status = init_interp_main(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001098 if (_PyStatus_EXCEPTION(status)) {
1099 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001100 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001101 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001102}
1103
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001104
Victor Stinner331a6a52019-05-27 16:39:22 +02001105PyStatus
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001106_Py_InitializeMain(void)
1107{
Victor Stinner331a6a52019-05-27 16:39:22 +02001108 PyStatus status = _PyRuntime_Initialize();
1109 if (_PyStatus_EXCEPTION(status)) {
1110 return status;
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001111 }
1112 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinnerb45d2592019-06-20 00:05:23 +02001113 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
Victor Stinner01b1cc12019-11-20 02:27:56 +01001114 return pyinit_main(tstate);
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001115}
1116
1117
Victor Stinner331a6a52019-05-27 16:39:22 +02001118PyStatus
1119Py_InitializeFromConfig(const PyConfig *config)
Eric Snow1abcf672017-05-23 21:46:51 -07001120{
Victor Stinner6d1c4672019-05-20 11:02:00 +02001121 if (config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001122 return _PyStatus_ERR("initialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +02001123 }
1124
Victor Stinner331a6a52019-05-27 16:39:22 +02001125 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001126
Victor Stinner331a6a52019-05-27 16:39:22 +02001127 status = _PyRuntime_Initialize();
1128 if (_PyStatus_EXCEPTION(status)) {
1129 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001130 }
1131 _PyRuntimeState *runtime = &_PyRuntime;
1132
Victor Stinnerb45d2592019-06-20 00:05:23 +02001133 PyThreadState *tstate = NULL;
1134 status = pyinit_core(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001135 if (_PyStatus_EXCEPTION(status)) {
1136 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001137 }
Victor Stinnerda7933e2020-04-13 03:04:28 +02001138 config = _PyInterpreterState_GetConfig(tstate->interp);
Victor Stinnerbc8ac6b2017-11-30 18:03:55 +01001139
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001140 if (config->_init_main) {
Victor Stinner01b1cc12019-11-20 02:27:56 +01001141 status = pyinit_main(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001142 if (_PyStatus_EXCEPTION(status)) {
1143 return status;
Victor Stinner484f20d2019-03-27 02:04:16 +01001144 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001145 }
Victor Stinner484f20d2019-03-27 02:04:16 +01001146
Victor Stinner331a6a52019-05-27 16:39:22 +02001147 return _PyStatus_OK();
Victor Stinner5ac27a52019-03-27 13:40:14 +01001148}
1149
1150
Eric Snow1abcf672017-05-23 21:46:51 -07001151void
Nick Coghland6009512014-11-20 21:39:37 +10001152Py_InitializeEx(int install_sigs)
1153{
Victor Stinner331a6a52019-05-27 16:39:22 +02001154 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001155
Victor Stinner331a6a52019-05-27 16:39:22 +02001156 status = _PyRuntime_Initialize();
1157 if (_PyStatus_EXCEPTION(status)) {
1158 Py_ExitStatusException(status);
Victor Stinner43125222019-04-24 18:23:53 +02001159 }
1160 _PyRuntimeState *runtime = &_PyRuntime;
1161
1162 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001163 /* bpo-33932: Calling Py_Initialize() twice does nothing. */
1164 return;
1165 }
1166
Victor Stinner331a6a52019-05-27 16:39:22 +02001167 PyConfig config;
Victor Stinner8462a492019-10-01 12:06:16 +02001168 _PyConfig_InitCompatConfig(&config);
Victor Stinner441b10c2019-09-28 04:28:35 +02001169
Victor Stinner1dc6e392018-07-25 02:49:17 +02001170 config.install_signal_handlers = install_sigs;
1171
Victor Stinner331a6a52019-05-27 16:39:22 +02001172 status = Py_InitializeFromConfig(&config);
1173 if (_PyStatus_EXCEPTION(status)) {
1174 Py_ExitStatusException(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001175 }
Nick Coghland6009512014-11-20 21:39:37 +10001176}
1177
1178void
1179Py_Initialize(void)
1180{
1181 Py_InitializeEx(1);
1182}
1183
1184
Nick Coghland6009512014-11-20 21:39:37 +10001185/* Flush stdout and stderr */
1186
1187static int
1188file_is_closed(PyObject *fobj)
1189{
1190 int r;
1191 PyObject *tmp = PyObject_GetAttrString(fobj, "closed");
1192 if (tmp == NULL) {
1193 PyErr_Clear();
1194 return 0;
1195 }
1196 r = PyObject_IsTrue(tmp);
1197 Py_DECREF(tmp);
1198 if (r < 0)
1199 PyErr_Clear();
1200 return r > 0;
1201}
1202
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001203static int
Nick Coghland6009512014-11-20 21:39:37 +10001204flush_std_files(void)
1205{
1206 PyObject *fout = _PySys_GetObjectId(&PyId_stdout);
1207 PyObject *ferr = _PySys_GetObjectId(&PyId_stderr);
1208 PyObject *tmp;
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001209 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001210
1211 if (fout != NULL && fout != Py_None && !file_is_closed(fout)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001212 tmp = _PyObject_CallMethodIdNoArgs(fout, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001213 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001214 PyErr_WriteUnraisable(fout);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001215 status = -1;
1216 }
Nick Coghland6009512014-11-20 21:39:37 +10001217 else
1218 Py_DECREF(tmp);
1219 }
1220
1221 if (ferr != NULL && ferr != Py_None && !file_is_closed(ferr)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001222 tmp = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001223 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001224 PyErr_Clear();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001225 status = -1;
1226 }
Nick Coghland6009512014-11-20 21:39:37 +10001227 else
1228 Py_DECREF(tmp);
1229 }
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001230
1231 return status;
Nick Coghland6009512014-11-20 21:39:37 +10001232}
1233
1234/* Undo the effect of Py_Initialize().
1235
1236 Beware: if multiple interpreter and/or thread states exist, these
1237 are not wiped out; only the current thread and interpreter state
1238 are deleted. But since everything else is deleted, those other
1239 interpreter and thread states should no longer be used.
1240
1241 (XXX We should do better, e.g. wipe out all interpreters and
1242 threads.)
1243
1244 Locking: as above.
1245
1246*/
1247
Victor Stinner7eee5be2019-11-20 10:38:34 +01001248
1249static void
1250finalize_interp_types(PyThreadState *tstate, int is_main_interp)
1251{
1252 if (is_main_interp) {
1253 /* Sundry finalizers */
Victor Stinner7eee5be2019-11-20 10:38:34 +01001254 _PyFrame_Fini();
Victor Stinner7eee5be2019-11-20 10:38:34 +01001255 _PyTuple_Fini();
1256 _PyList_Fini();
1257 _PySet_Fini();
1258 _PyBytes_Fini();
Victor Stinner630c8df2019-12-17 13:02:18 +01001259 }
1260
1261 _PyLong_Fini(tstate);
1262
1263 if (is_main_interp) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001264 _PyFloat_Fini();
1265 _PyDict_Fini();
1266 _PySlice_Fini();
1267 }
1268
1269 _PyWarnings_Fini(tstate->interp);
1270
1271 if (is_main_interp) {
1272 _Py_HashRandomization_Fini();
1273 _PyArg_Fini();
1274 _PyAsyncGen_Fini();
1275 _PyContext_Fini();
Victor Stinner3d483342019-11-22 12:27:50 +01001276 }
Victor Stinner7eee5be2019-11-20 10:38:34 +01001277
Victor Stinner3d483342019-11-22 12:27:50 +01001278 /* Cleanup Unicode implementation */
1279 _PyUnicode_Fini(tstate);
1280
1281 if (is_main_interp) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001282 _Py_ClearFileSystemEncoding();
1283 }
1284}
1285
1286
1287static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001288finalize_interp_clear(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001289{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001290 int is_main_interp = _Py_IsMainInterpreter(tstate);
1291
Victor Stinner7eee5be2019-11-20 10:38:34 +01001292 /* Clear interpreter state and all thread states */
1293 PyInterpreterState_Clear(tstate->interp);
1294
Pablo Galindoac0e1c22019-12-04 11:51:03 +00001295 /* Trigger a GC collection on subinterpreters*/
1296 if (!is_main_interp) {
1297 _PyGC_CollectNoFail();
1298 }
1299
Victor Stinner7eee5be2019-11-20 10:38:34 +01001300 finalize_interp_types(tstate, is_main_interp);
1301
1302 if (is_main_interp) {
1303 /* XXX Still allocated:
1304 - various static ad-hoc pointers to interned strings
1305 - int and float free list blocks
1306 - whatever various modules and libraries allocate
1307 */
1308
1309 PyGrammar_RemoveAccelerators(&_PyParser_Grammar);
1310
1311 _PyExc_Fini();
Victor Stinner7eee5be2019-11-20 10:38:34 +01001312 }
Victor Stinner72474072019-11-20 12:25:50 +01001313
1314 _PyGC_Fini(tstate);
Victor Stinner7eee5be2019-11-20 10:38:34 +01001315}
1316
1317
1318static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001319finalize_interp_delete(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001320{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001321 if (_Py_IsMainInterpreter(tstate)) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001322 /* Cleanup auto-thread-state */
1323 _PyGILState_Fini(tstate);
1324 }
1325
Victor Stinnerdda5d6e2020-04-08 17:54:59 +02001326 /* We can't call _PyEval_FiniGIL() here because destroying the GIL lock can
1327 fail when it is being awaited by another running daemon thread (see
1328 bpo-9901). Instead pycore_create_interpreter() destroys the previously
1329 created GIL, which ensures that Py_Initialize / Py_FinalizeEx can be
1330 called multiple times. */
1331
Victor Stinner7eee5be2019-11-20 10:38:34 +01001332 PyInterpreterState_Delete(tstate->interp);
1333}
1334
1335
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001336int
1337Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001338{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001339 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001340
Victor Stinner8e91c242019-04-24 17:24:01 +02001341 _PyRuntimeState *runtime = &_PyRuntime;
1342 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001343 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001344 }
Nick Coghland6009512014-11-20 21:39:37 +10001345
Victor Stinnere225beb2019-06-03 18:14:24 +02001346 /* Get current thread state and interpreter pointer */
1347 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
1348 PyInterpreterState *interp = tstate->interp;
Victor Stinner8e91c242019-04-24 17:24:01 +02001349
Victor Stinnerb45d2592019-06-20 00:05:23 +02001350 // Wrap up existing "threading"-module-created, non-daemon threads.
1351 wait_for_thread_shutdown(tstate);
1352
1353 // Make any remaining pending calls.
Victor Stinner2b1df452020-01-13 18:46:59 +01001354 _Py_FinishPendingCalls(tstate);
Victor Stinnerb45d2592019-06-20 00:05:23 +02001355
Nick Coghland6009512014-11-20 21:39:37 +10001356 /* The interpreter is still entirely intact at this point, and the
1357 * exit funcs may be relying on that. In particular, if some thread
1358 * or exit func is still waiting to do an import, the import machinery
1359 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001360 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001361 * Note that Threading.py uses an exit func to do a join on all the
1362 * threads created thru it, so this also protects pending imports in
1363 * the threads created via Threading.
1364 */
Nick Coghland6009512014-11-20 21:39:37 +10001365
Victor Stinnerb45d2592019-06-20 00:05:23 +02001366 call_py_exitfuncs(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001367
Victor Stinnerda273412017-12-15 01:46:02 +01001368 /* Copy the core config, PyInterpreterState_Delete() free
1369 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001370#ifdef Py_REF_DEBUG
Victor Stinner331a6a52019-05-27 16:39:22 +02001371 int show_ref_count = interp->config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001372#endif
1373#ifdef Py_TRACE_REFS
Victor Stinner331a6a52019-05-27 16:39:22 +02001374 int dump_refs = interp->config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001375#endif
1376#ifdef WITH_PYMALLOC
Victor Stinner331a6a52019-05-27 16:39:22 +02001377 int malloc_stats = interp->config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001378#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001379
Victor Stinnereb4e2ae2020-03-08 11:57:45 +01001380 /* Remaining daemon threads will automatically exit
1381 when they attempt to take the GIL (ex: PyEval_RestoreThread()). */
Victor Stinner7b3c2522020-03-07 00:24:23 +01001382 _PyRuntimeState_SetFinalizing(runtime, tstate);
Victor Stinner8e91c242019-04-24 17:24:01 +02001383 runtime->initialized = 0;
1384 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001385
Victor Stinner9ad58ac2020-03-09 23:37:49 +01001386 /* Destroy the state of all threads of the interpreter, except of the
1387 current thread. In practice, only daemon threads should still be alive,
1388 except if wait_for_thread_shutdown() has been cancelled by CTRL+C.
1389 Clear frames of other threads to call objects destructors. Destructors
1390 will be called in the current Python thread. Since
1391 _PyRuntimeState_SetFinalizing() has been called, no other Python thread
1392 can take the GIL at this point: if they try, they will exit
1393 immediately. */
1394 _PyThreadState_DeleteExcept(runtime, tstate);
1395
Victor Stinnere0deff32015-03-24 13:46:18 +01001396 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001397 if (flush_std_files() < 0) {
1398 status = -1;
1399 }
Nick Coghland6009512014-11-20 21:39:37 +10001400
1401 /* Disable signal handling */
1402 PyOS_FiniInterrupts();
1403
1404 /* Collect garbage. This may call finalizers; it's nice to call these
1405 * before all modules are destroyed.
1406 * XXX If a __del__ or weakref callback is triggered here, and tries to
1407 * XXX import a module, bad things can happen, because Python no
1408 * XXX longer believes it's initialized.
1409 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1410 * XXX is easy to provoke that way. I've also seen, e.g.,
1411 * XXX Exception exceptions.ImportError: 'No module named sha'
1412 * XXX in <function callback at 0x008F5718> ignored
1413 * XXX but I'm unclear on exactly how that one happens. In any case,
1414 * XXX I haven't seen a real-life report of either of these.
1415 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001416 _PyGC_CollectIfEnabled();
Eric Snowdae02762017-09-14 00:35:58 -07001417
Steve Dowerb82e17e2019-05-23 08:45:22 -07001418 /* Clear all loghooks */
Victor Stinner08faf002020-03-26 18:57:32 +01001419 _PySys_ClearAuditHooks(tstate);
Steve Dowerb82e17e2019-05-23 08:45:22 -07001420
Nick Coghland6009512014-11-20 21:39:37 +10001421 /* Destroy all modules */
Victor Stinner987a0dc2019-06-19 10:36:10 +02001422 _PyImport_Cleanup(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001423
Inada Naoki91234a12019-06-03 21:30:58 +09001424 /* Print debug stats if any */
1425 _PyEval_Fini();
1426
Victor Stinnere0deff32015-03-24 13:46:18 +01001427 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001428 if (flush_std_files() < 0) {
1429 status = -1;
1430 }
Nick Coghland6009512014-11-20 21:39:37 +10001431
1432 /* Collect final garbage. This disposes of cycles created by
1433 * class definitions, for example.
1434 * XXX This is disabled because it caused too many problems. If
1435 * XXX a __del__ or weakref callback triggers here, Python code has
1436 * XXX a hard time running, because even the sys module has been
1437 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1438 * XXX One symptom is a sequence of information-free messages
1439 * XXX coming from threads (if a __del__ or callback is invoked,
1440 * XXX other threads can execute too, and any exception they encounter
1441 * XXX triggers a comedy of errors as subsystem after subsystem
1442 * XXX fails to find what it *expects* to find in sys to help report
1443 * XXX the exception and consequent unexpected failures). I've also
1444 * XXX seen segfaults then, after adding print statements to the
1445 * XXX Python code getting called.
1446 */
1447#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001448 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001449#endif
1450
1451 /* Disable tracemalloc after all Python objects have been destroyed,
1452 so it is possible to use tracemalloc in objects destructor. */
1453 _PyTraceMalloc_Fini();
1454
1455 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1456 _PyImport_Fini();
1457
1458 /* Cleanup typeobject.c's internal caches. */
1459 _PyType_Fini();
1460
1461 /* unload faulthandler module */
1462 _PyFaulthandler_Fini();
1463
Nick Coghland6009512014-11-20 21:39:37 +10001464 /* dump hash stats */
1465 _PyHash_Fini();
1466
Eric Snowdae02762017-09-14 00:35:58 -07001467#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001468 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001469 _PyDebug_PrintTotalRefs();
1470 }
Eric Snowdae02762017-09-14 00:35:58 -07001471#endif
Nick Coghland6009512014-11-20 21:39:37 +10001472
1473#ifdef Py_TRACE_REFS
1474 /* Display all objects still alive -- this can invoke arbitrary
1475 * __repr__ overrides, so requires a mostly-intact interpreter.
1476 * Alas, a lot of stuff may still be alive now that will be cleaned
1477 * up later.
1478 */
Victor Stinnerda273412017-12-15 01:46:02 +01001479 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001480 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001481 }
Nick Coghland6009512014-11-20 21:39:37 +10001482#endif /* Py_TRACE_REFS */
1483
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001484 finalize_interp_clear(tstate);
1485 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001486
1487#ifdef Py_TRACE_REFS
1488 /* Display addresses (& refcnts) of all objects still alive.
1489 * An address can be used to find the repr of the object, printed
1490 * above by _Py_PrintReferences.
1491 */
Victor Stinnerda273412017-12-15 01:46:02 +01001492 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001493 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001494 }
Nick Coghland6009512014-11-20 21:39:37 +10001495#endif /* Py_TRACE_REFS */
Victor Stinner34be8072016-03-14 12:04:26 +01001496#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001497 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001498 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be8072016-03-14 12:04:26 +01001499 }
Nick Coghland6009512014-11-20 21:39:37 +10001500#endif
1501
Victor Stinner8e91c242019-04-24 17:24:01 +02001502 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001503
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001504 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001505 return status;
1506}
1507
1508void
1509Py_Finalize(void)
1510{
1511 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001512}
1513
Victor Stinnerb0051362019-11-22 17:52:42 +01001514
Nick Coghland6009512014-11-20 21:39:37 +10001515/* Create and initialize a new interpreter and thread, and return the
1516 new thread. This requires that Py_Initialize() has been called
1517 first.
1518
1519 Unsuccessful initialization yields a NULL pointer. Note that *no*
1520 exception information is available even in this case -- the
1521 exception information is held in the thread, and there is no
1522 thread.
1523
1524 Locking: as above.
1525
1526*/
1527
Victor Stinner331a6a52019-05-27 16:39:22 +02001528static PyStatus
Victor Stinner252346a2020-05-01 11:33:44 +02001529new_interpreter(PyThreadState **tstate_p, int isolated_subinterpreter)
Nick Coghland6009512014-11-20 21:39:37 +10001530{
Victor Stinner331a6a52019-05-27 16:39:22 +02001531 PyStatus status;
Nick Coghland6009512014-11-20 21:39:37 +10001532
Victor Stinner331a6a52019-05-27 16:39:22 +02001533 status = _PyRuntime_Initialize();
1534 if (_PyStatus_EXCEPTION(status)) {
1535 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001536 }
1537 _PyRuntimeState *runtime = &_PyRuntime;
1538
1539 if (!runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001540 return _PyStatus_ERR("Py_Initialize must be called first");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001541 }
Nick Coghland6009512014-11-20 21:39:37 +10001542
Victor Stinner8a1be612016-03-14 22:07:55 +01001543 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1544 interpreters: disable PyGILState_Check(). */
Victor Stinner1c4cbdf2020-04-13 11:45:21 +02001545 runtime->gilstate.check_enabled = 0;
Victor Stinner8a1be612016-03-14 22:07:55 +01001546
Victor Stinner43125222019-04-24 18:23:53 +02001547 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001548 if (interp == NULL) {
1549 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001550 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001551 }
Nick Coghland6009512014-11-20 21:39:37 +10001552
Victor Stinner43125222019-04-24 18:23:53 +02001553 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001554 if (tstate == NULL) {
1555 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001556 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001557 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001558 }
1559
Victor Stinner43125222019-04-24 18:23:53 +02001560 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001561
Eric Snow1abcf672017-05-23 21:46:51 -07001562 /* Copy the current interpreter config into the new interpreter */
Victor Stinnerda7933e2020-04-13 03:04:28 +02001563 const PyConfig *config;
Eric Snow1abcf672017-05-23 21:46:51 -07001564 if (save_tstate != NULL) {
Victor Stinnerda7933e2020-04-13 03:04:28 +02001565 config = _PyInterpreterState_GetConfig(save_tstate->interp);
Eric Snow1abcf672017-05-23 21:46:51 -07001566 } else {
1567 /* No current thread state, copy from the main interpreter */
1568 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinnerda7933e2020-04-13 03:04:28 +02001569 config = _PyInterpreterState_GetConfig(main_interp);
Victor Stinnerda273412017-12-15 01:46:02 +01001570 }
1571
Victor Stinnerda7933e2020-04-13 03:04:28 +02001572 status = _PyInterpreterState_SetConfig(interp, config);
Victor Stinner331a6a52019-05-27 16:39:22 +02001573 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001574 goto error;
Victor Stinnerda273412017-12-15 01:46:02 +01001575 }
Victor Stinner252346a2020-05-01 11:33:44 +02001576 interp->config._isolated_interpreter = isolated_subinterpreter;
Eric Snow1abcf672017-05-23 21:46:51 -07001577
Victor Stinnerd863ade2019-12-06 03:37:07 +01001578 status = pycore_interp_init(tstate);
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001579 if (_PyStatus_EXCEPTION(status)) {
1580 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001581 }
1582
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001583 status = init_interp_main(tstate);
1584 if (_PyStatus_EXCEPTION(status)) {
1585 goto error;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001586 }
Nick Coghland6009512014-11-20 21:39:37 +10001587
Victor Stinnerdda5d6e2020-04-08 17:54:59 +02001588 status = init_interp_create_gil(tstate);
Victor Stinner50e6e992020-03-19 02:41:21 +01001589 if (_PyStatus_EXCEPTION(status)) {
1590 return status;
1591 }
1592
Victor Stinnera7368ac2017-11-15 18:11:45 -08001593 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +02001594 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001595
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001596error:
Victor Stinnerb0051362019-11-22 17:52:42 +01001597 *tstate_p = NULL;
1598
1599 /* Oops, it didn't work. Undo it all. */
Nick Coghland6009512014-11-20 21:39:37 +10001600 PyErr_PrintEx(0);
1601 PyThreadState_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001602 PyThreadState_Delete(tstate);
1603 PyInterpreterState_Delete(interp);
Victor Stinner9da74302019-11-20 11:17:17 +01001604 PyThreadState_Swap(save_tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001605
Victor Stinnerb0051362019-11-22 17:52:42 +01001606 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001607}
1608
1609PyThreadState *
Victor Stinner252346a2020-05-01 11:33:44 +02001610_Py_NewInterpreter(int isolated_subinterpreter)
Victor Stinnera7368ac2017-11-15 18:11:45 -08001611{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001612 PyThreadState *tstate = NULL;
Victor Stinner252346a2020-05-01 11:33:44 +02001613 PyStatus status = new_interpreter(&tstate, isolated_subinterpreter);
Victor Stinner331a6a52019-05-27 16:39:22 +02001614 if (_PyStatus_EXCEPTION(status)) {
1615 Py_ExitStatusException(status);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001616 }
1617 return tstate;
1618
Nick Coghland6009512014-11-20 21:39:37 +10001619}
1620
Victor Stinner252346a2020-05-01 11:33:44 +02001621PyThreadState *
1622Py_NewInterpreter(void)
1623{
1624 return _Py_NewInterpreter(0);
1625}
1626
Nick Coghland6009512014-11-20 21:39:37 +10001627/* Delete an interpreter and its last thread. This requires that the
1628 given thread state is current, that the thread has no remaining
1629 frames, and that it is its interpreter's only remaining thread.
1630 It is a fatal error to violate these constraints.
1631
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001632 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001633 everything, regardless.)
1634
1635 Locking: as above.
1636
1637*/
1638
1639void
1640Py_EndInterpreter(PyThreadState *tstate)
1641{
1642 PyInterpreterState *interp = tstate->interp;
1643
Victor Stinnerb45d2592019-06-20 00:05:23 +02001644 if (tstate != _PyThreadState_GET()) {
Victor Stinner9e5d30c2020-03-07 00:54:20 +01001645 Py_FatalError("thread is not current");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001646 }
1647 if (tstate->frame != NULL) {
Victor Stinner9e5d30c2020-03-07 00:54:20 +01001648 Py_FatalError("thread still has a frame");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001649 }
Eric Snow5be45a62019-03-08 22:47:07 -07001650 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001651
Eric Snow842a2f02019-03-15 15:47:51 -06001652 // Wrap up existing "threading"-module-created, non-daemon threads.
Victor Stinnerb45d2592019-06-20 00:05:23 +02001653 wait_for_thread_shutdown(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001654
Victor Stinnerb45d2592019-06-20 00:05:23 +02001655 call_py_exitfuncs(tstate);
Marcel Plch776407f2017-12-20 11:17:58 +01001656
Victor Stinnerb45d2592019-06-20 00:05:23 +02001657 if (tstate != interp->tstate_head || tstate->next != NULL) {
Victor Stinner9e5d30c2020-03-07 00:54:20 +01001658 Py_FatalError("not the last thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001659 }
Nick Coghland6009512014-11-20 21:39:37 +10001660
Victor Stinner987a0dc2019-06-19 10:36:10 +02001661 _PyImport_Cleanup(tstate);
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001662 finalize_interp_clear(tstate);
1663 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001664}
1665
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001666/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001667
Victor Stinner331a6a52019-05-27 16:39:22 +02001668static PyStatus
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001669add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001670{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001671 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001672 m = PyImport_AddModule("__main__");
1673 if (m == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +02001674 return _PyStatus_ERR("can't create __main__ module");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001675
Nick Coghland6009512014-11-20 21:39:37 +10001676 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001677 ann_dict = PyDict_New();
1678 if ((ann_dict == NULL) ||
1679 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001680 return _PyStatus_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001681 }
1682 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001683
Nick Coghland6009512014-11-20 21:39:37 +10001684 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1685 PyObject *bimod = PyImport_ImportModule("builtins");
1686 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001687 return _PyStatus_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001688 }
1689 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001690 return _PyStatus_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001691 }
1692 Py_DECREF(bimod);
1693 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001694
Nick Coghland6009512014-11-20 21:39:37 +10001695 /* Main is a little special - imp.is_builtin("__main__") will return
1696 * False, but BuiltinImporter is still the most appropriate initial
1697 * setting for its __loader__ attribute. A more suitable value will
1698 * be set if __main__ gets further initialized later in the startup
1699 * process.
1700 */
1701 loader = PyDict_GetItemString(d, "__loader__");
1702 if (loader == NULL || loader == Py_None) {
1703 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1704 "BuiltinImporter");
1705 if (loader == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001706 return _PyStatus_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001707 }
1708 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001709 return _PyStatus_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001710 }
1711 Py_DECREF(loader);
1712 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001713 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001714}
1715
Nick Coghland6009512014-11-20 21:39:37 +10001716/* Import the site module (not into __main__ though) */
1717
Victor Stinner331a6a52019-05-27 16:39:22 +02001718static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001719init_import_site(void)
Nick Coghland6009512014-11-20 21:39:37 +10001720{
1721 PyObject *m;
1722 m = PyImport_ImportModule("site");
1723 if (m == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001724 return _PyStatus_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001725 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001726 Py_DECREF(m);
Victor Stinner331a6a52019-05-27 16:39:22 +02001727 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001728}
1729
Victor Stinner874dbe82015-09-04 17:29:57 +02001730/* Check if a file descriptor is valid or not.
1731 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1732static int
1733is_valid_fd(int fd)
1734{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001735/* dup() is faster than fstat(): fstat() can require input/output operations,
1736 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1737 startup. Problem: dup() doesn't check if the file descriptor is valid on
1738 some platforms.
1739
1740 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1741 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1742 EBADF. FreeBSD has similar issue (bpo-32849).
1743
1744 Only use dup() on platforms where dup() is enough to detect invalid FD in
1745 corner cases: on Linux and Windows (bpo-32849). */
1746#if defined(__linux__) || defined(MS_WINDOWS)
1747 if (fd < 0) {
1748 return 0;
1749 }
1750 int fd2;
1751
1752 _Py_BEGIN_SUPPRESS_IPH
1753 fd2 = dup(fd);
1754 if (fd2 >= 0) {
1755 close(fd2);
1756 }
1757 _Py_END_SUPPRESS_IPH
1758
1759 return (fd2 >= 0);
1760#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001761 struct stat st;
1762 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001763#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001764}
1765
1766/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001767static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02001768create_stdio(const PyConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001769 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001770 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001771{
1772 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1773 const char* mode;
1774 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001775 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001776 int buffering, isatty;
1777 _Py_IDENTIFIER(open);
1778 _Py_IDENTIFIER(isatty);
1779 _Py_IDENTIFIER(TextIOWrapper);
1780 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001781 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001782
Victor Stinner874dbe82015-09-04 17:29:57 +02001783 if (!is_valid_fd(fd))
1784 Py_RETURN_NONE;
1785
Nick Coghland6009512014-11-20 21:39:37 +10001786 /* stdin is always opened in buffered mode, first because it shouldn't
1787 make a difference in common use cases, second because TextIOWrapper
1788 depends on the presence of a read1() method which only exists on
1789 buffered streams.
1790 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001791 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001792 buffering = 0;
1793 else
1794 buffering = -1;
1795 if (write_mode)
1796 mode = "wb";
1797 else
1798 mode = "rb";
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001799 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOO",
Nick Coghland6009512014-11-20 21:39:37 +10001800 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001801 Py_None, Py_None, /* encoding, errors */
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001802 Py_None, Py_False); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001803 if (buf == NULL)
1804 goto error;
1805
1806 if (buffering) {
1807 _Py_IDENTIFIER(raw);
1808 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1809 if (raw == NULL)
1810 goto error;
1811 }
1812 else {
1813 raw = buf;
1814 Py_INCREF(raw);
1815 }
1816
Steve Dower39294992016-08-30 21:22:36 -07001817#ifdef MS_WINDOWS
1818 /* Windows console IO is always UTF-8 encoded */
1819 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001820 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001821#endif
1822
Nick Coghland6009512014-11-20 21:39:37 +10001823 text = PyUnicode_FromString(name);
1824 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1825 goto error;
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001826 res = _PyObject_CallMethodIdNoArgs(raw, &PyId_isatty);
Nick Coghland6009512014-11-20 21:39:37 +10001827 if (res == NULL)
1828 goto error;
1829 isatty = PyObject_IsTrue(res);
1830 Py_DECREF(res);
1831 if (isatty == -1)
1832 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001833 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001834 write_through = Py_True;
1835 else
1836 write_through = Py_False;
Jendrik Seipp5b907712020-01-01 23:21:43 +01001837 if (buffered_stdio && (isatty || fd == fileno(stderr)))
Nick Coghland6009512014-11-20 21:39:37 +10001838 line_buffering = Py_True;
1839 else
1840 line_buffering = Py_False;
1841
1842 Py_CLEAR(raw);
1843 Py_CLEAR(text);
1844
1845#ifdef MS_WINDOWS
1846 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1847 newlines to "\n".
1848 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1849 newline = NULL;
1850#else
1851 /* sys.stdin: split lines at "\n".
1852 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1853 newline = "\n";
1854#endif
1855
Victor Stinner709d23d2019-05-02 14:56:30 -04001856 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1857 if (encoding_str == NULL) {
1858 Py_CLEAR(buf);
1859 goto error;
1860 }
1861
1862 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1863 if (errors_str == NULL) {
1864 Py_CLEAR(buf);
1865 Py_CLEAR(encoding_str);
1866 goto error;
1867 }
1868
1869 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1870 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001871 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001872 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001873 Py_CLEAR(encoding_str);
1874 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001875 if (stream == NULL)
1876 goto error;
1877
1878 if (write_mode)
1879 mode = "w";
1880 else
1881 mode = "r";
1882 text = PyUnicode_FromString(mode);
1883 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1884 goto error;
1885 Py_CLEAR(text);
1886 return stream;
1887
1888error:
1889 Py_XDECREF(buf);
1890 Py_XDECREF(stream);
1891 Py_XDECREF(text);
1892 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001893
Victor Stinner874dbe82015-09-04 17:29:57 +02001894 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1895 /* Issue #24891: the file descriptor was closed after the first
1896 is_valid_fd() check was called. Ignore the OSError and set the
1897 stream to None. */
1898 PyErr_Clear();
1899 Py_RETURN_NONE;
1900 }
1901 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001902}
1903
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001904/* Set builtins.open to io.OpenWrapper */
1905static PyStatus
Andy Lester75cd5bf2020-03-12 02:49:05 -05001906init_set_builtins_open(void)
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001907{
1908 PyObject *iomod = NULL, *wrapper;
1909 PyObject *bimod = NULL;
1910 PyStatus res = _PyStatus_OK();
1911
1912 if (!(iomod = PyImport_ImportModule("io"))) {
1913 goto error;
1914 }
1915
1916 if (!(bimod = PyImport_ImportModule("builtins"))) {
1917 goto error;
1918 }
1919
1920 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1921 goto error;
1922 }
1923
1924 /* Set builtins.open */
1925 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1926 Py_DECREF(wrapper);
1927 goto error;
1928 }
1929 Py_DECREF(wrapper);
1930 goto done;
1931
1932error:
1933 res = _PyStatus_ERR("can't initialize io.open");
1934
1935done:
1936 Py_XDECREF(bimod);
1937 Py_XDECREF(iomod);
1938 return res;
1939}
1940
1941
Nick Coghland6009512014-11-20 21:39:37 +10001942/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinner331a6a52019-05-27 16:39:22 +02001943static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001944init_sys_streams(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10001945{
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001946 PyObject *iomod = NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001947 PyObject *m;
1948 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001949 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001950 PyObject * encoding_attr;
Victor Stinner331a6a52019-05-27 16:39:22 +02001951 PyStatus res = _PyStatus_OK();
Victor Stinnerda7933e2020-04-13 03:04:28 +02001952 const PyConfig *config = _PyInterpreterState_GetConfig(tstate->interp);
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001953
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001954 /* Check that stdin is not a directory
1955 Using shell redirection, you can redirect stdin to a directory,
1956 crashing the Python interpreter. Catch this common mistake here
1957 and output a useful error message. Note that under MS Windows,
1958 the shell already prevents that. */
1959#ifndef MS_WINDOWS
1960 struct _Py_stat_struct sb;
1961 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1962 S_ISDIR(sb.st_mode)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001963 return _PyStatus_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001964 }
1965#endif
1966
Nick Coghland6009512014-11-20 21:39:37 +10001967 /* Hack to avoid a nasty recursion issue when Python is invoked
1968 in verbose mode: pre-import the Latin-1 and UTF-8 codecs */
1969 if ((m = PyImport_ImportModule("encodings.utf_8")) == NULL) {
1970 goto error;
1971 }
1972 Py_DECREF(m);
1973
1974 if (!(m = PyImport_ImportModule("encodings.latin_1"))) {
1975 goto error;
1976 }
1977 Py_DECREF(m);
1978
Nick Coghland6009512014-11-20 21:39:37 +10001979 if (!(iomod = PyImport_ImportModule("io"))) {
1980 goto error;
1981 }
Nick Coghland6009512014-11-20 21:39:37 +10001982
Nick Coghland6009512014-11-20 21:39:37 +10001983 /* Set sys.stdin */
1984 fd = fileno(stdin);
1985 /* Under some conditions stdin, stdout and stderr may not be connected
1986 * and fileno() may point to an invalid file descriptor. For example
1987 * GUI apps don't have valid standard streams by default.
1988 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001989 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001990 config->stdio_encoding,
1991 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001992 if (std == NULL)
1993 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001994 PySys_SetObject("__stdin__", std);
1995 _PySys_SetObjectId(&PyId_stdin, std);
1996 Py_DECREF(std);
1997
1998 /* Set sys.stdout */
1999 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02002000 std = create_stdio(config, iomod, fd, 1, "<stdout>",
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("__stdout__", std);
2006 _PySys_SetObjectId(&PyId_stdout, std);
2007 Py_DECREF(std);
2008
2009#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
2010 /* Set sys.stderr, replaces the preliminary stderr */
2011 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02002012 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02002013 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04002014 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02002015 if (std == NULL)
2016 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10002017
2018 /* Same as hack above, pre-import stderr's codec to avoid recursion
2019 when import.c tries to write to stderr in verbose mode. */
2020 encoding_attr = PyObject_GetAttrString(std, "encoding");
2021 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02002022 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10002023 if (std_encoding != NULL) {
2024 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
2025 Py_XDECREF(codec_info);
2026 }
2027 Py_DECREF(encoding_attr);
2028 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02002029 _PyErr_Clear(tstate); /* Not a fatal error if codec isn't available */
Nick Coghland6009512014-11-20 21:39:37 +10002030
2031 if (PySys_SetObject("__stderr__", std) < 0) {
2032 Py_DECREF(std);
2033 goto error;
2034 }
2035 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
2036 Py_DECREF(std);
2037 goto error;
2038 }
2039 Py_DECREF(std);
2040#endif
2041
Victor Stinnera7368ac2017-11-15 18:11:45 -08002042 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10002043
Victor Stinnera7368ac2017-11-15 18:11:45 -08002044error:
Victor Stinner331a6a52019-05-27 16:39:22 +02002045 res = _PyStatus_ERR("can't initialize sys standard streams");
Victor Stinnera7368ac2017-11-15 18:11:45 -08002046
2047done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02002048 _Py_ClearStandardStreamEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10002049 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08002050 return res;
Nick Coghland6009512014-11-20 21:39:37 +10002051}
2052
2053
Victor Stinner10dc4842015-03-24 12:01:30 +01002054static void
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002055_Py_FatalError_DumpTracebacks(int fd, PyInterpreterState *interp,
2056 PyThreadState *tstate)
Victor Stinner10dc4842015-03-24 12:01:30 +01002057{
Victor Stinner10dc4842015-03-24 12:01:30 +01002058 fputc('\n', stderr);
2059 fflush(stderr);
2060
2061 /* display the current Python stack */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002062 _Py_DumpTracebackThreads(fd, interp, tstate);
Victor Stinner10dc4842015-03-24 12:01:30 +01002063}
Victor Stinner791da1c2016-03-14 16:53:12 +01002064
2065/* Print the current exception (if an exception is set) with its traceback,
2066 or display the current Python stack.
2067
2068 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
2069 called on catastrophic cases.
2070
2071 Return 1 if the traceback was displayed, 0 otherwise. */
2072
2073static int
Andy Lester75cd5bf2020-03-12 02:49:05 -05002074_Py_FatalError_PrintExc(PyThreadState *tstate)
Victor Stinner791da1c2016-03-14 16:53:12 +01002075{
2076 PyObject *ferr, *res;
2077 PyObject *exception, *v, *tb;
2078 int has_tb;
2079
Victor Stinnerb45d2592019-06-20 00:05:23 +02002080 _PyErr_Fetch(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002081 if (exception == NULL) {
2082 /* No current exception */
2083 return 0;
2084 }
2085
2086 ferr = _PySys_GetObjectId(&PyId_stderr);
2087 if (ferr == NULL || ferr == Py_None) {
2088 /* sys.stderr is not set yet or set to None,
2089 no need to try to display the exception */
2090 return 0;
2091 }
2092
Victor Stinnerb45d2592019-06-20 00:05:23 +02002093 _PyErr_NormalizeException(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002094 if (tb == NULL) {
2095 tb = Py_None;
2096 Py_INCREF(tb);
2097 }
2098 PyException_SetTraceback(v, tb);
2099 if (exception == NULL) {
2100 /* PyErr_NormalizeException() failed */
2101 return 0;
2102 }
2103
2104 has_tb = (tb != Py_None);
2105 PyErr_Display(exception, v, tb);
2106 Py_XDECREF(exception);
2107 Py_XDECREF(v);
2108 Py_XDECREF(tb);
2109
2110 /* sys.stderr may be buffered: call sys.stderr.flush() */
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002111 res = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002112 if (res == NULL) {
2113 _PyErr_Clear(tstate);
2114 }
2115 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002116 Py_DECREF(res);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002117 }
Victor Stinner791da1c2016-03-14 16:53:12 +01002118
2119 return has_tb;
2120}
2121
Nick Coghland6009512014-11-20 21:39:37 +10002122/* Print fatal error message and abort */
2123
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002124#ifdef MS_WINDOWS
2125static void
2126fatal_output_debug(const char *msg)
2127{
2128 /* buffer of 256 bytes allocated on the stack */
2129 WCHAR buffer[256 / sizeof(WCHAR)];
2130 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2131 size_t msglen;
2132
2133 OutputDebugStringW(L"Fatal Python error: ");
2134
2135 msglen = strlen(msg);
2136 while (msglen) {
2137 size_t i;
2138
2139 if (buflen > msglen) {
2140 buflen = msglen;
2141 }
2142
2143 /* Convert the message to wchar_t. This uses a simple one-to-one
2144 conversion, assuming that the this error message actually uses
2145 ASCII only. If this ceases to be true, we will have to convert. */
2146 for (i=0; i < buflen; ++i) {
2147 buffer[i] = msg[i];
2148 }
2149 buffer[i] = L'\0';
2150 OutputDebugStringW(buffer);
2151
2152 msg += buflen;
2153 msglen -= buflen;
2154 }
2155 OutputDebugStringW(L"\n");
2156}
2157#endif
2158
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002159
2160static void
2161fatal_error_dump_runtime(FILE *stream, _PyRuntimeState *runtime)
2162{
2163 fprintf(stream, "Python runtime state: ");
Victor Stinner7b3c2522020-03-07 00:24:23 +01002164 PyThreadState *finalizing = _PyRuntimeState_GetFinalizing(runtime);
2165 if (finalizing) {
2166 fprintf(stream, "finalizing (tstate=%p)", finalizing);
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002167 }
2168 else if (runtime->initialized) {
2169 fprintf(stream, "initialized");
2170 }
2171 else if (runtime->core_initialized) {
2172 fprintf(stream, "core initialized");
2173 }
2174 else if (runtime->preinitialized) {
2175 fprintf(stream, "preinitialized");
2176 }
2177 else if (runtime->preinitializing) {
2178 fprintf(stream, "preinitializing");
2179 }
2180 else {
2181 fprintf(stream, "unknown");
2182 }
2183 fprintf(stream, "\n");
2184 fflush(stream);
2185}
2186
2187
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002188static inline void _Py_NO_RETURN
2189fatal_error_exit(int status)
Nick Coghland6009512014-11-20 21:39:37 +10002190{
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002191 if (status < 0) {
2192#if defined(MS_WINDOWS) && defined(_DEBUG)
2193 DebugBreak();
2194#endif
2195 abort();
2196 }
2197 else {
2198 exit(status);
2199 }
2200}
2201
2202
2203static void _Py_NO_RETURN
2204fatal_error(FILE *stream, int header, const char *prefix, const char *msg,
2205 int status)
2206{
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002207 const int fd = fileno(stream);
Victor Stinner53345a42015-03-25 01:55:14 +01002208 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002209
2210 if (reentrant) {
2211 /* Py_FatalError() caused a second fatal error.
2212 Example: flush_std_files() raises a recursion error. */
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002213 fatal_error_exit(status);
Victor Stinner53345a42015-03-25 01:55:14 +01002214 }
2215 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002216
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002217 if (header) {
2218 fprintf(stream, "Fatal Python error: ");
2219 if (prefix) {
2220 fputs(prefix, stream);
2221 fputs(": ", stream);
2222 }
2223 if (msg) {
2224 fputs(msg, stream);
2225 }
2226 else {
2227 fprintf(stream, "<message not set>");
2228 }
2229 fputs("\n", stream);
2230 fflush(stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002231 }
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002232
2233 _PyRuntimeState *runtime = &_PyRuntime;
2234 fatal_error_dump_runtime(stream, runtime);
2235
2236 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
2237 PyInterpreterState *interp = NULL;
2238 if (tstate != NULL) {
2239 interp = tstate->interp;
2240 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002241
Victor Stinner3a228ab2018-11-01 00:26:41 +01002242 /* Check if the current thread has a Python thread state
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002243 and holds the GIL.
Victor Stinner3a228ab2018-11-01 00:26:41 +01002244
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002245 tss_tstate is NULL if Py_FatalError() is called from a C thread which
2246 has no Python thread state.
2247
2248 tss_tstate != tstate if the current Python thread does not hold the GIL.
2249 */
2250 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2251 int has_tstate_and_gil = (tss_tstate != NULL && tss_tstate == tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002252 if (has_tstate_and_gil) {
2253 /* If an exception is set, print the exception with its traceback */
Andy Lester75cd5bf2020-03-12 02:49:05 -05002254 if (!_Py_FatalError_PrintExc(tss_tstate)) {
Victor Stinner3a228ab2018-11-01 00:26:41 +01002255 /* No exception is set, or an exception is set without traceback */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002256 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002257 }
2258 }
2259 else {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002260 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002261 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002262
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002263 /* The main purpose of faulthandler is to display the traceback.
2264 This function already did its best to display a traceback.
2265 Disable faulthandler to prevent writing a second traceback
2266 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002267 _PyFaulthandler_Fini();
2268
Victor Stinner791da1c2016-03-14 16:53:12 +01002269 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002270 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002271 /* Flush sys.stdout and sys.stderr */
2272 flush_std_files();
2273 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002274
Nick Coghland6009512014-11-20 21:39:37 +10002275#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002276 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002277#endif /* MS_WINDOWS */
2278
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002279 fatal_error_exit(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002280}
2281
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002282
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002283#undef Py_FatalError
2284
Victor Stinner19760862017-12-20 01:41:59 +01002285void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002286Py_FatalError(const char *msg)
2287{
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002288 fatal_error(stderr, 1, NULL, msg, -1);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002289}
2290
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002291
Victor Stinner19760862017-12-20 01:41:59 +01002292void _Py_NO_RETURN
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002293_Py_FatalErrorFunc(const char *func, const char *msg)
2294{
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002295 fatal_error(stderr, 1, func, msg, -1);
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002296}
2297
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002298
2299void _Py_NO_RETURN
2300_Py_FatalErrorFormat(const char *func, const char *format, ...)
2301{
2302 static int reentrant = 0;
2303 if (reentrant) {
2304 /* _Py_FatalErrorFormat() caused a second fatal error */
2305 fatal_error_exit(-1);
2306 }
2307 reentrant = 1;
2308
2309 FILE *stream = stderr;
2310 fprintf(stream, "Fatal Python error: ");
2311 if (func) {
2312 fputs(func, stream);
2313 fputs(": ", stream);
2314 }
2315 fflush(stream);
2316
2317 va_list vargs;
2318#ifdef HAVE_STDARG_PROTOTYPES
2319 va_start(vargs, format);
2320#else
2321 va_start(vargs);
2322#endif
2323 vfprintf(stream, format, vargs);
2324 va_end(vargs);
2325
2326 fputs("\n", stream);
2327 fflush(stream);
2328
2329 fatal_error(stream, 0, NULL, NULL, -1);
2330}
2331
2332
Victor Stinner9e5d30c2020-03-07 00:54:20 +01002333void _Py_NO_RETURN
Victor Stinner331a6a52019-05-27 16:39:22 +02002334Py_ExitStatusException(PyStatus status)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002335{
Victor Stinner331a6a52019-05-27 16:39:22 +02002336 if (_PyStatus_IS_EXIT(status)) {
2337 exit(status.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002338 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002339 else if (_PyStatus_IS_ERROR(status)) {
Victor Stinner87d3b9d2020-03-25 19:27:36 +01002340 fatal_error(stderr, 1, status.func, status.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002341 }
2342 else {
Victor Stinner331a6a52019-05-27 16:39:22 +02002343 Py_FatalError("Py_ExitStatusException() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002344 }
Nick Coghland6009512014-11-20 21:39:37 +10002345}
2346
2347/* Clean up and exit */
2348
Nick Coghland6009512014-11-20 21:39:37 +10002349/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002350void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002351{
Victor Stinner81a7be32020-04-14 15:14:01 +02002352 PyInterpreterState *is = _PyInterpreterState_GET();
Marcel Plch776407f2017-12-20 11:17:58 +01002353
Antoine Pitroufc5db952017-12-13 02:29:07 +01002354 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002355 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2356
2357 is->pyexitfunc = func;
2358 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002359}
2360
2361static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002362call_py_exitfuncs(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002363{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002364 PyInterpreterState *interp = tstate->interp;
2365 if (interp->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002366 return;
2367
Victor Stinnerb45d2592019-06-20 00:05:23 +02002368 (*interp->pyexitfunc)(interp->pyexitmodule);
2369 _PyErr_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10002370}
2371
2372/* Wait until threading._shutdown completes, provided
2373 the threading module was imported in the first place.
2374 The shutdown routine will wait until all non-daemon
2375 "threading" threads have completed. */
2376static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002377wait_for_thread_shutdown(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002378{
Nick Coghland6009512014-11-20 21:39:37 +10002379 _Py_IDENTIFIER(_shutdown);
2380 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002381 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002382 if (threading == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +02002383 if (_PyErr_Occurred(tstate)) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002384 PyErr_WriteUnraisable(NULL);
2385 }
2386 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002387 return;
2388 }
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002389 result = _PyObject_CallMethodIdNoArgs(threading, &PyId__shutdown);
Nick Coghland6009512014-11-20 21:39:37 +10002390 if (result == NULL) {
2391 PyErr_WriteUnraisable(threading);
2392 }
2393 else {
2394 Py_DECREF(result);
2395 }
2396 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002397}
2398
2399#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002400int Py_AtExit(void (*func)(void))
2401{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002402 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002403 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002404 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002405 return 0;
2406}
2407
2408static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002409call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002410{
Victor Stinner8e91c242019-04-24 17:24:01 +02002411 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002412 /* pop last function from the list */
2413 runtime->nexitfuncs--;
2414 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2415 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2416
2417 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002418 }
Nick Coghland6009512014-11-20 21:39:37 +10002419
2420 fflush(stdout);
2421 fflush(stderr);
2422}
2423
Victor Stinnercfc88312018-08-01 16:41:25 +02002424void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002425Py_Exit(int sts)
2426{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002427 if (Py_FinalizeEx() < 0) {
2428 sts = 120;
2429 }
Nick Coghland6009512014-11-20 21:39:37 +10002430
2431 exit(sts);
2432}
2433
Victor Stinner331a6a52019-05-27 16:39:22 +02002434static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02002435init_signals(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002436{
2437#ifdef SIGPIPE
2438 PyOS_setsig(SIGPIPE, SIG_IGN);
2439#endif
2440#ifdef SIGXFZ
2441 PyOS_setsig(SIGXFZ, SIG_IGN);
2442#endif
2443#ifdef SIGXFSZ
2444 PyOS_setsig(SIGXFSZ, SIG_IGN);
2445#endif
Victor Stinner400e1db2020-03-31 19:13:10 +02002446 PyOS_InitInterrupts(); /* May imply init_signals() */
Victor Stinnerb45d2592019-06-20 00:05:23 +02002447 if (_PyErr_Occurred(tstate)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002448 return _PyStatus_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002449 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002450 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002451}
2452
2453
2454/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2455 *
2456 * All of the code in this function must only use async-signal-safe functions,
2457 * listed at `man 7 signal` or
2458 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
Victor Stinnerefc28bb2020-03-05 18:13:56 +01002459 *
2460 * If this function is updated, update also _posix_spawn() of subprocess.py.
Nick Coghland6009512014-11-20 21:39:37 +10002461 */
2462void
2463_Py_RestoreSignals(void)
2464{
2465#ifdef SIGPIPE
2466 PyOS_setsig(SIGPIPE, SIG_DFL);
2467#endif
2468#ifdef SIGXFZ
2469 PyOS_setsig(SIGXFZ, SIG_DFL);
2470#endif
2471#ifdef SIGXFSZ
2472 PyOS_setsig(SIGXFSZ, SIG_DFL);
2473#endif
2474}
2475
2476
2477/*
2478 * The file descriptor fd is considered ``interactive'' if either
2479 * a) isatty(fd) is TRUE, or
2480 * b) the -i flag was given, and the filename associated with
2481 * the descriptor is NULL or "<stdin>" or "???".
2482 */
2483int
2484Py_FdIsInteractive(FILE *fp, const char *filename)
2485{
2486 if (isatty((int)fileno(fp)))
2487 return 1;
2488 if (!Py_InteractiveFlag)
2489 return 0;
2490 return (filename == NULL) ||
2491 (strcmp(filename, "<stdin>") == 0) ||
2492 (strcmp(filename, "???") == 0);
2493}
2494
2495
Nick Coghland6009512014-11-20 21:39:37 +10002496/* Wrappers around sigaction() or signal(). */
2497
2498PyOS_sighandler_t
2499PyOS_getsig(int sig)
2500{
2501#ifdef HAVE_SIGACTION
2502 struct sigaction context;
2503 if (sigaction(sig, NULL, &context) == -1)
2504 return SIG_ERR;
2505 return context.sa_handler;
2506#else
2507 PyOS_sighandler_t handler;
2508/* Special signal handling for the secure CRT in Visual Studio 2005 */
2509#if defined(_MSC_VER) && _MSC_VER >= 1400
2510 switch (sig) {
2511 /* Only these signals are valid */
2512 case SIGINT:
2513 case SIGILL:
2514 case SIGFPE:
2515 case SIGSEGV:
2516 case SIGTERM:
2517 case SIGBREAK:
2518 case SIGABRT:
2519 break;
2520 /* Don't call signal() with other values or it will assert */
2521 default:
2522 return SIG_ERR;
2523 }
2524#endif /* _MSC_VER && _MSC_VER >= 1400 */
2525 handler = signal(sig, SIG_IGN);
2526 if (handler != SIG_ERR)
2527 signal(sig, handler);
2528 return handler;
2529#endif
2530}
2531
2532/*
2533 * All of the code in this function must only use async-signal-safe functions,
2534 * listed at `man 7 signal` or
2535 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2536 */
2537PyOS_sighandler_t
2538PyOS_setsig(int sig, PyOS_sighandler_t handler)
2539{
2540#ifdef HAVE_SIGACTION
2541 /* Some code in Modules/signalmodule.c depends on sigaction() being
2542 * used here if HAVE_SIGACTION is defined. Fix that if this code
2543 * changes to invalidate that assumption.
2544 */
2545 struct sigaction context, ocontext;
2546 context.sa_handler = handler;
2547 sigemptyset(&context.sa_mask);
2548 context.sa_flags = 0;
2549 if (sigaction(sig, &context, &ocontext) == -1)
2550 return SIG_ERR;
2551 return ocontext.sa_handler;
2552#else
2553 PyOS_sighandler_t oldhandler;
2554 oldhandler = signal(sig, handler);
2555#ifdef HAVE_SIGINTERRUPT
2556 siginterrupt(sig, 1);
2557#endif
2558 return oldhandler;
2559#endif
2560}
2561
2562#ifdef __cplusplus
2563}
2564#endif