blob: 823d96e86a4388498edf7335fb794310f7c1a07e [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 Stinner09532fe2019-05-10 23:39:09 +02007#include "pycore_ceval.h"
Victor Stinner99fcc612019-04-29 13:04:07 +02008#include "pycore_context.h"
Victor Stinner0a28f8d2019-06-19 02:54:39 +02009#include "pycore_import.h" /* _PyImport_FindBuiltin */
Victor Stinner331a6a52019-05-27 16:39:22 +020010#include "pycore_initconfig.h"
Victor Stinner353933e2018-11-23 13:08:26 +010011#include "pycore_fileutils.h"
Victor Stinner27e2d1f2018-11-01 00:52:28 +010012#include "pycore_hamt.h"
Victor Stinnera1c249c2018-11-01 03:15:58 +010013#include "pycore_pathconfig.h"
Victor Stinnerb45d2592019-06-20 00:05:23 +020014#include "pycore_pyerrors.h"
Victor Stinner621cebe2018-11-12 16:53:38 +010015#include "pycore_pylifecycle.h"
16#include "pycore_pymem.h"
17#include "pycore_pystate.h"
Victor Stinnered488662019-05-20 00:14:57 +020018#include "pycore_traceback.h"
Nick Coghland6009512014-11-20 21:39:37 +100019#include "grammar.h"
20#include "node.h"
21#include "token.h"
22#include "parsetok.h"
23#include "errcode.h"
24#include "code.h"
25#include "symtable.h"
26#include "ast.h"
27#include "marshal.h"
28#include "osdefs.h"
29#include <locale.h>
30
31#ifdef HAVE_SIGNAL_H
32#include <signal.h>
33#endif
34
35#ifdef MS_WINDOWS
36#include "malloc.h" /* for alloca */
37#endif
38
39#ifdef HAVE_LANGINFO_H
40#include <langinfo.h>
41#endif
42
43#ifdef MS_WINDOWS
44#undef BYTE
45#include "windows.h"
Steve Dower39294992016-08-30 21:22:36 -070046
47extern PyTypeObject PyWindowsConsoleIO_Type;
48#define PyWindowsConsoleIO_Check(op) (PyObject_TypeCheck((op), &PyWindowsConsoleIO_Type))
Nick Coghland6009512014-11-20 21:39:37 +100049#endif
50
51_Py_IDENTIFIER(flush);
52_Py_IDENTIFIER(name);
53_Py_IDENTIFIER(stdin);
54_Py_IDENTIFIER(stdout);
55_Py_IDENTIFIER(stderr);
Eric Snow3f9eee62017-09-15 16:35:20 -060056_Py_IDENTIFIER(threading);
Nick Coghland6009512014-11-20 21:39:37 +100057
58#ifdef __cplusplus
59extern "C" {
60#endif
61
Nick Coghland6009512014-11-20 21:39:37 +100062extern grammar _PyParser_Grammar; /* From graminit.c */
63
Victor Stinnerb45d2592019-06-20 00:05:23 +020064/* Forward declarations */
Victor Stinner331a6a52019-05-27 16:39:22 +020065static PyStatus add_main_module(PyInterpreterState *interp);
Victor Stinnerb45d2592019-06-20 00:05:23 +020066static PyStatus init_import_site(void);
Victor Stinnere0c9ab82019-11-22 16:19:14 +010067static PyStatus init_set_builtins_open(PyThreadState *tstate);
Victor Stinnerb45d2592019-06-20 00:05:23 +020068static PyStatus init_sys_streams(PyThreadState *tstate);
69static PyStatus init_signals(PyThreadState *tstate);
70static void call_py_exitfuncs(PyThreadState *tstate);
71static void wait_for_thread_shutdown(PyThreadState *tstate);
Victor Stinner8e91c242019-04-24 17:24:01 +020072static void call_ll_exitfuncs(_PyRuntimeState *runtime);
Nick Coghland6009512014-11-20 21:39:37 +100073
Gregory P. Smith38f11cc2019-02-16 12:57:40 -080074int _Py_UnhandledKeyboardInterrupt = 0;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080075_PyRuntimeState _PyRuntime = _PyRuntimeState_INIT;
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010076static int runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060077
Victor Stinner331a6a52019-05-27 16:39:22 +020078PyStatus
Eric Snow2ebc5ce2017-09-07 23:51:28 -060079_PyRuntime_Initialize(void)
80{
81 /* XXX We only initialize once in the process, which aligns with
82 the static initialization of the former globals now found in
83 _PyRuntime. However, _PyRuntime *should* be initialized with
84 every Py_Initialize() call, but doing so breaks the runtime.
85 This is because the runtime state is not properly finalized
86 currently. */
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010087 if (runtime_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +020088 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -080089 }
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010090 runtime_initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080091
92 return _PyRuntimeState_Init(&_PyRuntime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -060093}
94
95void
96_PyRuntime_Finalize(void)
97{
98 _PyRuntimeState_Fini(&_PyRuntime);
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010099 runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600100}
101
102int
103_Py_IsFinalizing(void)
104{
105 return _PyRuntime.finalizing != NULL;
106}
107
Nick Coghland6009512014-11-20 21:39:37 +1000108/* Hack to force loading of object files */
109int (*_PyOS_mystrnicmp_hack)(const char *, const char *, Py_ssize_t) = \
110 PyOS_mystrnicmp; /* Python/pystrcmp.o */
111
112/* PyModule_GetWarningsModule is no longer necessary as of 2.6
113since _warnings is builtin. This API should not be used. */
114PyObject *
115PyModule_GetWarningsModule(void)
116{
117 return PyImport_ImportModule("warnings");
118}
119
Eric Snowc7ec9982017-05-23 23:00:52 -0700120
Eric Snow1abcf672017-05-23 21:46:51 -0700121/* APIs to access the initialization flags
122 *
123 * Can be called prior to Py_Initialize.
124 */
Nick Coghland6009512014-11-20 21:39:37 +1000125
Eric Snow1abcf672017-05-23 21:46:51 -0700126int
127_Py_IsCoreInitialized(void)
128{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600129 return _PyRuntime.core_initialized;
Eric Snow1abcf672017-05-23 21:46:51 -0700130}
Nick Coghland6009512014-11-20 21:39:37 +1000131
132int
133Py_IsInitialized(void)
134{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600135 return _PyRuntime.initialized;
Nick Coghland6009512014-11-20 21:39:37 +1000136}
137
Nick Coghlan6ea41862017-06-11 13:16:15 +1000138
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000139/* Global initializations. Can be undone by Py_FinalizeEx(). Don't
140 call this twice without an intervening Py_FinalizeEx() call. When
Nick Coghland6009512014-11-20 21:39:37 +1000141 initializations fail, a fatal error is issued and the function does
142 not return. On return, the first thread and interpreter state have
143 been created.
144
145 Locking: you must hold the interpreter lock while calling this.
146 (If the lock has not yet been initialized, that's equivalent to
147 having the lock, but you cannot use multiple threads.)
148
149*/
150
Victor Stinner331a6a52019-05-27 16:39:22 +0200151static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200152init_importlib(PyThreadState *tstate, PyObject *sysmod)
Nick Coghland6009512014-11-20 21:39:37 +1000153{
154 PyObject *importlib;
155 PyObject *impmod;
Nick Coghland6009512014-11-20 21:39:37 +1000156 PyObject *value;
Victor Stinnerb45d2592019-06-20 00:05:23 +0200157 PyInterpreterState *interp = tstate->interp;
Victor Stinner331a6a52019-05-27 16:39:22 +0200158 int verbose = interp->config.verbose;
Nick Coghland6009512014-11-20 21:39:37 +1000159
160 /* Import _importlib through its frozen version, _frozen_importlib. */
161 if (PyImport_ImportFrozenModule("_frozen_importlib") <= 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200162 return _PyStatus_ERR("can't import _frozen_importlib");
Nick Coghland6009512014-11-20 21:39:37 +1000163 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200164 else if (verbose) {
Nick Coghland6009512014-11-20 21:39:37 +1000165 PySys_FormatStderr("import _frozen_importlib # frozen\n");
166 }
167 importlib = PyImport_AddModule("_frozen_importlib");
168 if (importlib == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200169 return _PyStatus_ERR("couldn't get _frozen_importlib from sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000170 }
171 interp->importlib = importlib;
172 Py_INCREF(interp->importlib);
173
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300174 interp->import_func = PyDict_GetItemString(interp->builtins, "__import__");
175 if (interp->import_func == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +0200176 return _PyStatus_ERR("__import__ not found");
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300177 Py_INCREF(interp->import_func);
178
Victor Stinnercd6e6942015-09-18 09:11:57 +0200179 /* Import the _imp module */
Benjamin Petersonc65ef772018-01-29 11:33:57 -0800180 impmod = PyInit__imp();
Nick Coghland6009512014-11-20 21:39:37 +1000181 if (impmod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200182 return _PyStatus_ERR("can't import _imp");
Nick Coghland6009512014-11-20 21:39:37 +1000183 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200184 else if (verbose) {
Victor Stinnercd6e6942015-09-18 09:11:57 +0200185 PySys_FormatStderr("import _imp # builtin\n");
Nick Coghland6009512014-11-20 21:39:37 +1000186 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600187 if (_PyImport_SetModuleString("_imp", impmod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200188 return _PyStatus_ERR("can't save _imp to sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000189 }
190
Victor Stinnercd6e6942015-09-18 09:11:57 +0200191 /* Install importlib as the implementation of import */
Nick Coghland6009512014-11-20 21:39:37 +1000192 value = PyObject_CallMethod(importlib, "_install", "OO", sysmod, impmod);
193 if (value == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200194 _PyErr_Print(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200195 return _PyStatus_ERR("importlib install failed");
Nick Coghland6009512014-11-20 21:39:37 +1000196 }
197 Py_DECREF(value);
198 Py_DECREF(impmod);
199
Victor Stinner331a6a52019-05-27 16:39:22 +0200200 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000201}
202
Victor Stinner331a6a52019-05-27 16:39:22 +0200203static PyStatus
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200204init_importlib_external(PyThreadState *tstate)
Eric Snow1abcf672017-05-23 21:46:51 -0700205{
206 PyObject *value;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200207 value = PyObject_CallMethod(tstate->interp->importlib,
Eric Snow1abcf672017-05-23 21:46:51 -0700208 "_install_external_importers", "");
209 if (value == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200210 _PyErr_Print(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200211 return _PyStatus_ERR("external importer setup failed");
Eric Snow1abcf672017-05-23 21:46:51 -0700212 }
Stéphane Wirtelab1cb802017-06-08 13:13:20 +0200213 Py_DECREF(value);
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200214 return _PyImportZip_Init(tstate);
Eric Snow1abcf672017-05-23 21:46:51 -0700215}
Nick Coghland6009512014-11-20 21:39:37 +1000216
Nick Coghlan6ea41862017-06-11 13:16:15 +1000217/* Helper functions to better handle the legacy C locale
218 *
219 * The legacy C locale assumes ASCII as the default text encoding, which
220 * causes problems not only for the CPython runtime, but also other
221 * components like GNU readline.
222 *
223 * Accordingly, when the CLI detects it, it attempts to coerce it to a
224 * more capable UTF-8 based alternative as follows:
225 *
226 * if (_Py_LegacyLocaleDetected()) {
227 * _Py_CoerceLegacyLocale();
228 * }
229 *
230 * See the documentation of the PYTHONCOERCECLOCALE setting for more details.
231 *
232 * Locale coercion also impacts the default error handler for the standard
233 * streams: while the usual default is "strict", the default for the legacy
234 * C locale and for any of the coercion target locales is "surrogateescape".
235 */
236
237int
Victor Stinner0f721472019-05-20 17:16:38 +0200238_Py_LegacyLocaleDetected(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000239{
240#ifndef MS_WINDOWS
Victor Stinner0f721472019-05-20 17:16:38 +0200241 if (!warn) {
242 const char *locale_override = getenv("LC_ALL");
243 if (locale_override != NULL && *locale_override != '\0') {
244 /* Don't coerce C locale if the LC_ALL environment variable
245 is set */
246 return 0;
247 }
248 }
249
Nick Coghlan6ea41862017-06-11 13:16:15 +1000250 /* On non-Windows systems, the C locale is considered a legacy locale */
Nick Coghlaneb817952017-06-18 12:29:42 +1000251 /* XXX (ncoghlan): some platforms (notably Mac OS X) don't appear to treat
252 * the POSIX locale as a simple alias for the C locale, so
253 * we may also want to check for that explicitly.
254 */
Nick Coghlan6ea41862017-06-11 13:16:15 +1000255 const char *ctype_loc = setlocale(LC_CTYPE, NULL);
256 return ctype_loc != NULL && strcmp(ctype_loc, "C") == 0;
257#else
258 /* Windows uses code pages instead of locales, so no locale is legacy */
259 return 0;
260#endif
261}
262
Victor Stinnerb0051362019-11-22 17:52:42 +0100263#ifndef MS_WINDOWS
Nick Coghlaneb817952017-06-18 12:29:42 +1000264static const char *_C_LOCALE_WARNING =
265 "Python runtime initialized with LC_CTYPE=C (a locale with default ASCII "
266 "encoding), which may cause Unicode compatibility problems. Using C.UTF-8, "
267 "C.utf8, or UTF-8 (if available) as alternative Unicode-compatible "
268 "locales is recommended.\n";
269
Nick Coghlaneb817952017-06-18 12:29:42 +1000270static void
Victor Stinner43125222019-04-24 18:23:53 +0200271emit_stderr_warning_for_legacy_locale(_PyRuntimeState *runtime)
Nick Coghlaneb817952017-06-18 12:29:42 +1000272{
Victor Stinner331a6a52019-05-27 16:39:22 +0200273 const PyPreConfig *preconfig = &runtime->preconfig;
Victor Stinner0f721472019-05-20 17:16:38 +0200274 if (preconfig->coerce_c_locale_warn && _Py_LegacyLocaleDetected(1)) {
Victor Stinnercf215042018-08-29 22:56:06 +0200275 PySys_FormatStderr("%s", _C_LOCALE_WARNING);
Nick Coghlaneb817952017-06-18 12:29:42 +1000276 }
277}
Victor Stinnerb0051362019-11-22 17:52:42 +0100278#endif /* !defined(MS_WINDOWS) */
Nick Coghlaneb817952017-06-18 12:29:42 +1000279
Nick Coghlan6ea41862017-06-11 13:16:15 +1000280typedef struct _CandidateLocale {
281 const char *locale_name; /* The locale to try as a coercion target */
282} _LocaleCoercionTarget;
283
284static _LocaleCoercionTarget _TARGET_LOCALES[] = {
285 {"C.UTF-8"},
286 {"C.utf8"},
Nick Coghlan18974c32017-06-30 00:48:14 +1000287 {"UTF-8"},
Nick Coghlan6ea41862017-06-11 13:16:15 +1000288 {NULL}
289};
290
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200291
292int
293_Py_IsLocaleCoercionTarget(const char *ctype_loc)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000294{
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200295 const _LocaleCoercionTarget *target = NULL;
296 for (target = _TARGET_LOCALES; target->locale_name; target++) {
297 if (strcmp(ctype_loc, target->locale_name) == 0) {
298 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000299 }
Victor Stinner124b9eb2018-08-29 01:29:06 +0200300 }
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200301 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000302}
303
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200304
Nick Coghlan6ea41862017-06-11 13:16:15 +1000305#ifdef PY_COERCE_C_LOCALE
Victor Stinner94540602017-12-16 04:54:22 +0100306static const char C_LOCALE_COERCION_WARNING[] =
Nick Coghlan6ea41862017-06-11 13:16:15 +1000307 "Python detected LC_CTYPE=C: LC_CTYPE coerced to %.20s (set another locale "
308 "or PYTHONCOERCECLOCALE=0 to disable this locale coercion behavior).\n";
309
Victor Stinner0f721472019-05-20 17:16:38 +0200310static int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200311_coerce_default_locale_settings(int warn, const _LocaleCoercionTarget *target)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000312{
313 const char *newloc = target->locale_name;
314
315 /* Reset locale back to currently configured defaults */
xdegaye1588be62017-11-12 12:45:59 +0100316 _Py_SetLocaleFromEnv(LC_ALL);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000317
318 /* Set the relevant locale environment variable */
319 if (setenv("LC_CTYPE", newloc, 1)) {
320 fprintf(stderr,
321 "Error setting LC_CTYPE, skipping C locale coercion\n");
Victor Stinner0f721472019-05-20 17:16:38 +0200322 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000323 }
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200324 if (warn) {
Victor Stinner94540602017-12-16 04:54:22 +0100325 fprintf(stderr, C_LOCALE_COERCION_WARNING, newloc);
Nick Coghlaneb817952017-06-18 12:29:42 +1000326 }
Nick Coghlan6ea41862017-06-11 13:16:15 +1000327
328 /* Reconfigure with the overridden environment variables */
xdegaye1588be62017-11-12 12:45:59 +0100329 _Py_SetLocaleFromEnv(LC_ALL);
Victor Stinner0f721472019-05-20 17:16:38 +0200330 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000331}
332#endif
333
Victor Stinner0f721472019-05-20 17:16:38 +0200334int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200335_Py_CoerceLegacyLocale(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000336{
Victor Stinner0f721472019-05-20 17:16:38 +0200337 int coerced = 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000338#ifdef PY_COERCE_C_LOCALE
Victor Stinner8ea09112018-09-03 17:05:18 +0200339 char *oldloc = NULL;
340
341 oldloc = _PyMem_RawStrdup(setlocale(LC_CTYPE, NULL));
342 if (oldloc == NULL) {
Victor Stinner0f721472019-05-20 17:16:38 +0200343 return coerced;
Victor Stinner8ea09112018-09-03 17:05:18 +0200344 }
345
Victor Stinner94540602017-12-16 04:54:22 +0100346 const char *locale_override = getenv("LC_ALL");
347 if (locale_override == NULL || *locale_override == '\0') {
348 /* LC_ALL is also not set (or is set to an empty string) */
349 const _LocaleCoercionTarget *target = NULL;
350 for (target = _TARGET_LOCALES; target->locale_name; target++) {
351 const char *new_locale = setlocale(LC_CTYPE,
352 target->locale_name);
353 if (new_locale != NULL) {
Victor Stinnere2510952019-05-02 11:28:57 -0400354#if !defined(_Py_FORCE_UTF8_LOCALE) && defined(HAVE_LANGINFO_H) && defined(CODESET)
Victor Stinner94540602017-12-16 04:54:22 +0100355 /* Also ensure that nl_langinfo works in this locale */
356 char *codeset = nl_langinfo(CODESET);
357 if (!codeset || *codeset == '\0') {
358 /* CODESET is not set or empty, so skip coercion */
359 new_locale = NULL;
360 _Py_SetLocaleFromEnv(LC_CTYPE);
361 continue;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000362 }
Victor Stinner94540602017-12-16 04:54:22 +0100363#endif
364 /* Successfully configured locale, so make it the default */
Victor Stinner0f721472019-05-20 17:16:38 +0200365 coerced = _coerce_default_locale_settings(warn, target);
Victor Stinner8ea09112018-09-03 17:05:18 +0200366 goto done;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000367 }
368 }
369 }
370 /* No C locale warning here, as Py_Initialize will emit one later */
Victor Stinner8ea09112018-09-03 17:05:18 +0200371
372 setlocale(LC_CTYPE, oldloc);
373
374done:
375 PyMem_RawFree(oldloc);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000376#endif
Victor Stinner0f721472019-05-20 17:16:38 +0200377 return coerced;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000378}
379
xdegaye1588be62017-11-12 12:45:59 +0100380/* _Py_SetLocaleFromEnv() is a wrapper around setlocale(category, "") to
381 * isolate the idiosyncrasies of different libc implementations. It reads the
382 * appropriate environment variable and uses its value to select the locale for
383 * 'category'. */
384char *
385_Py_SetLocaleFromEnv(int category)
386{
Victor Stinner353933e2018-11-23 13:08:26 +0100387 char *res;
xdegaye1588be62017-11-12 12:45:59 +0100388#ifdef __ANDROID__
389 const char *locale;
390 const char **pvar;
391#ifdef PY_COERCE_C_LOCALE
392 const char *coerce_c_locale;
393#endif
394 const char *utf8_locale = "C.UTF-8";
395 const char *env_var_set[] = {
396 "LC_ALL",
397 "LC_CTYPE",
398 "LANG",
399 NULL,
400 };
401
402 /* Android setlocale(category, "") doesn't check the environment variables
403 * and incorrectly sets the "C" locale at API 24 and older APIs. We only
404 * check the environment variables listed in env_var_set. */
405 for (pvar=env_var_set; *pvar; pvar++) {
406 locale = getenv(*pvar);
407 if (locale != NULL && *locale != '\0') {
408 if (strcmp(locale, utf8_locale) == 0 ||
409 strcmp(locale, "en_US.UTF-8") == 0) {
410 return setlocale(category, utf8_locale);
411 }
412 return setlocale(category, "C");
413 }
414 }
415
416 /* Android uses UTF-8, so explicitly set the locale to C.UTF-8 if none of
417 * LC_ALL, LC_CTYPE, or LANG is set to a non-empty string.
418 * Quote from POSIX section "8.2 Internationalization Variables":
419 * "4. If the LANG environment variable is not set or is set to the empty
420 * string, the implementation-defined default locale shall be used." */
421
422#ifdef PY_COERCE_C_LOCALE
423 coerce_c_locale = getenv("PYTHONCOERCECLOCALE");
424 if (coerce_c_locale == NULL || strcmp(coerce_c_locale, "0") != 0) {
425 /* Some other ported code may check the environment variables (e.g. in
426 * extension modules), so we make sure that they match the locale
427 * configuration */
428 if (setenv("LC_CTYPE", utf8_locale, 1)) {
429 fprintf(stderr, "Warning: failed setting the LC_CTYPE "
430 "environment variable to %s\n", utf8_locale);
431 }
432 }
433#endif
Victor Stinner353933e2018-11-23 13:08:26 +0100434 res = setlocale(category, utf8_locale);
435#else /* !defined(__ANDROID__) */
436 res = setlocale(category, "");
437#endif
438 _Py_ResetForceASCII();
439 return res;
xdegaye1588be62017-11-12 12:45:59 +0100440}
441
Nick Coghlan6ea41862017-06-11 13:16:15 +1000442
Eric Snow1abcf672017-05-23 21:46:51 -0700443/* Global initializations. Can be undone by Py_Finalize(). Don't
444 call this twice without an intervening Py_Finalize() call.
445
Victor Stinner331a6a52019-05-27 16:39:22 +0200446 Every call to Py_InitializeFromConfig, Py_Initialize or Py_InitializeEx
Eric Snow1abcf672017-05-23 21:46:51 -0700447 must have a corresponding call to Py_Finalize.
448
449 Locking: you must hold the interpreter lock while calling these APIs.
450 (If the lock has not yet been initialized, that's equivalent to
451 having the lock, but you cannot use multiple threads.)
452
453*/
454
Victor Stinner331a6a52019-05-27 16:39:22 +0200455static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200456pyinit_core_reconfigure(_PyRuntimeState *runtime,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200457 PyThreadState **tstate_p,
Victor Stinner331a6a52019-05-27 16:39:22 +0200458 const PyConfig *config)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200459{
Victor Stinner331a6a52019-05-27 16:39:22 +0200460 PyStatus status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100461 PyThreadState *tstate = _PyThreadState_GET();
462 if (!tstate) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200463 return _PyStatus_ERR("failed to read thread state");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100464 }
Victor Stinnerb45d2592019-06-20 00:05:23 +0200465 *tstate_p = tstate;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100466
467 PyInterpreterState *interp = tstate->interp;
468 if (interp == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200469 return _PyStatus_ERR("can't make main interpreter");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100470 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100471
Victor Stinner331a6a52019-05-27 16:39:22 +0200472 _PyConfig_Write(config, runtime);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200473
Victor Stinner331a6a52019-05-27 16:39:22 +0200474 status = _PyConfig_Copy(&interp->config, config);
475 if (_PyStatus_EXCEPTION(status)) {
476 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200477 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200478 config = &interp->config;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200479
Victor Stinner331a6a52019-05-27 16:39:22 +0200480 if (config->_install_importlib) {
Victor Stinner12f2f172019-09-26 15:51:50 +0200481 status = _PyConfig_WritePathConfig(config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200482 if (_PyStatus_EXCEPTION(status)) {
483 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200484 }
485 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200486 return _PyStatus_OK();
Victor Stinner1dc6e392018-07-25 02:49:17 +0200487}
488
489
Victor Stinner331a6a52019-05-27 16:39:22 +0200490static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200491pycore_init_runtime(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200492 const PyConfig *config)
Nick Coghland6009512014-11-20 21:39:37 +1000493{
Victor Stinner43125222019-04-24 18:23:53 +0200494 if (runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200495 return _PyStatus_ERR("main interpreter already initialized");
Victor Stinner1dc6e392018-07-25 02:49:17 +0200496 }
Victor Stinnerda273412017-12-15 01:46:02 +0100497
Victor Stinner331a6a52019-05-27 16:39:22 +0200498 _PyConfig_Write(config, runtime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600499
Eric Snow1abcf672017-05-23 21:46:51 -0700500 /* Py_Finalize leaves _Py_Finalizing set in order to help daemon
501 * threads behave a little more gracefully at interpreter shutdown.
502 * We clobber it here so the new interpreter can start with a clean
503 * slate.
504 *
505 * However, this may still lead to misbehaviour if there are daemon
506 * threads still hanging around from a previous Py_Initialize/Finalize
507 * pair :(
508 */
Victor Stinner43125222019-04-24 18:23:53 +0200509 runtime->finalizing = NULL;
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600510
Victor Stinner331a6a52019-05-27 16:39:22 +0200511 PyStatus status = _Py_HashRandomization_Init(config);
512 if (_PyStatus_EXCEPTION(status)) {
513 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800514 }
515
Victor Stinner331a6a52019-05-27 16:39:22 +0200516 status = _PyInterpreterState_Enable(runtime);
517 if (_PyStatus_EXCEPTION(status)) {
518 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -0800519 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200520 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100521}
Victor Stinnera7368ac2017-11-15 18:11:45 -0800522
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100523
Victor Stinner331a6a52019-05-27 16:39:22 +0200524static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200525pycore_create_interpreter(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200526 const PyConfig *config,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200527 PyThreadState **tstate_p)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100528{
529 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnerda273412017-12-15 01:46:02 +0100530 if (interp == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200531 return _PyStatus_ERR("can't make main interpreter");
Victor Stinnerda273412017-12-15 01:46:02 +0100532 }
533
Victor Stinner331a6a52019-05-27 16:39:22 +0200534 PyStatus status = _PyConfig_Copy(&interp->config, config);
535 if (_PyStatus_EXCEPTION(status)) {
536 return status;
Victor Stinnerda273412017-12-15 01:46:02 +0100537 }
Nick Coghland6009512014-11-20 21:39:37 +1000538
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200539 PyThreadState *tstate = PyThreadState_New(interp);
Victor Stinnerb45d2592019-06-20 00:05:23 +0200540 if (tstate == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200541 return _PyStatus_ERR("can't make first thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +0200542 }
Nick Coghland6009512014-11-20 21:39:37 +1000543 (void) PyThreadState_Swap(tstate);
544
Victor Stinner99fcc612019-04-29 13:04:07 +0200545 /* We can't call _PyEval_FiniThreads() in Py_FinalizeEx because
546 destroying the GIL might fail when it is being referenced from
547 another running thread (see issue #9901).
Nick Coghland6009512014-11-20 21:39:37 +1000548 Instead we destroy the previously created GIL here, which ensures
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000549 that we can call Py_Initialize / Py_FinalizeEx multiple times. */
Victor Stinner09532fe2019-05-10 23:39:09 +0200550 _PyEval_FiniThreads(&runtime->ceval);
Victor Stinner2914bb32018-01-29 11:57:45 +0100551
Nick Coghland6009512014-11-20 21:39:37 +1000552 /* Auto-thread-state API */
Victor Stinner01b1cc12019-11-20 02:27:56 +0100553 _PyGILState_Init(tstate);
Nick Coghland6009512014-11-20 21:39:37 +1000554
Victor Stinner2914bb32018-01-29 11:57:45 +0100555 /* Create the GIL */
556 PyEval_InitThreads();
557
Victor Stinnerb45d2592019-06-20 00:05:23 +0200558 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +0200559 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100560}
Nick Coghland6009512014-11-20 21:39:37 +1000561
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100562
Victor Stinner331a6a52019-05-27 16:39:22 +0200563static PyStatus
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100564pycore_init_types(PyThreadState *tstate)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100565{
Victor Stinner444b39b2019-11-20 01:18:11 +0100566 PyStatus status;
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100567 int is_main_interp = _Py_IsMainInterpreter(tstate);
Victor Stinner444b39b2019-11-20 01:18:11 +0100568
Victor Stinner01b1cc12019-11-20 02:27:56 +0100569 status = _PyGC_Init(tstate);
Victor Stinner444b39b2019-11-20 01:18:11 +0100570 if (_PyStatus_EXCEPTION(status)) {
571 return status;
572 }
573
Victor Stinnere7e699e2019-11-20 12:08:13 +0100574 if (is_main_interp) {
575 status = _PyTypes_Init();
576 if (_PyStatus_EXCEPTION(status)) {
577 return status;
578 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100579
Victor Stinnere7e699e2019-11-20 12:08:13 +0100580 if (!_PyLong_Init()) {
581 return _PyStatus_ERR("can't init longs");
582 }
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100583 }
Victor Stinneref5aa9a2019-11-20 00:38:03 +0100584
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100585 if (is_main_interp) {
Victor Stinnere7e699e2019-11-20 12:08:13 +0100586 status = _PyUnicode_Init();
587 if (_PyStatus_EXCEPTION(status)) {
588 return status;
589 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100590 }
591
Victor Stinner331a6a52019-05-27 16:39:22 +0200592 status = _PyExc_Init();
593 if (_PyStatus_EXCEPTION(status)) {
594 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100595 }
596
Victor Stinnere7e699e2019-11-20 12:08:13 +0100597 if (is_main_interp) {
598 if (!_PyFloat_Init()) {
599 return _PyStatus_ERR("can't init float");
600 }
Nick Coghland6009512014-11-20 21:39:37 +1000601
Victor Stinnere7e699e2019-11-20 12:08:13 +0100602 if (_PyStructSequence_Init() < 0) {
603 return _PyStatus_ERR("can't initialize structseq");
604 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100605 }
Victor Stinneref9d9b62019-05-22 11:28:22 +0200606
Victor Stinner331a6a52019-05-27 16:39:22 +0200607 status = _PyErr_Init();
608 if (_PyStatus_EXCEPTION(status)) {
609 return status;
Victor Stinneref9d9b62019-05-22 11:28:22 +0200610 }
611
Victor Stinnere7e699e2019-11-20 12:08:13 +0100612 if (is_main_interp) {
613 if (!_PyContext_Init()) {
614 return _PyStatus_ERR("can't init context");
615 }
Victor Stinneref5aa9a2019-11-20 00:38:03 +0100616 }
617
Victor Stinner331a6a52019-05-27 16:39:22 +0200618 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100619}
620
621
Victor Stinner331a6a52019-05-27 16:39:22 +0200622static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200623pycore_init_builtins(PyThreadState *tstate)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100624{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100625 assert(!_PyErr_Occurred(tstate));
626
Victor Stinnerb45d2592019-06-20 00:05:23 +0200627 PyObject *bimod = _PyBuiltin_Init(tstate);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100628 if (bimod == NULL) {
Victor Stinner2582d462019-11-22 19:24:49 +0100629 goto error;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100630 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100631
Victor Stinner2582d462019-11-22 19:24:49 +0100632 PyInterpreterState *interp = tstate->interp;
633 if (_PyImport_FixupBuiltin(bimod, "builtins", interp->modules) < 0) {
634 goto error;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100635 }
Victor Stinner2582d462019-11-22 19:24:49 +0100636
637 PyObject *builtins_dict = PyModule_GetDict(bimod);
638 if (builtins_dict == NULL) {
639 goto error;
640 }
641 Py_INCREF(builtins_dict);
642 interp->builtins = builtins_dict;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100643
Victor Stinner331a6a52019-05-27 16:39:22 +0200644 PyStatus status = _PyBuiltins_AddExceptions(bimod);
645 if (_PyStatus_EXCEPTION(status)) {
646 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100647 }
Victor Stinner2582d462019-11-22 19:24:49 +0100648
649 interp->builtins_copy = PyDict_Copy(interp->builtins);
650 if (interp->builtins_copy == NULL) {
651 goto error;
652 }
Pablo Galindob96c6b02019-12-04 11:19:59 +0000653 Py_DECREF(bimod);
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100654
655 assert(!_PyErr_Occurred(tstate));
656
Victor Stinner331a6a52019-05-27 16:39:22 +0200657 return _PyStatus_OK();
Victor Stinner2582d462019-11-22 19:24:49 +0100658
659error:
Pablo Galindob96c6b02019-12-04 11:19:59 +0000660 Py_XDECREF(bimod);
Victor Stinner2582d462019-11-22 19:24:49 +0100661 return _PyStatus_ERR("can't initialize builtins module");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100662}
663
664
Victor Stinner331a6a52019-05-27 16:39:22 +0200665static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200666pycore_init_import_warnings(PyThreadState *tstate, PyObject *sysmod)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100667{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100668 assert(!_PyErr_Occurred(tstate));
Victor Stinnerb45d2592019-06-20 00:05:23 +0200669
Victor Stinner2582d462019-11-22 19:24:49 +0100670 PyStatus status = _PyImportHooks_Init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200671 if (_PyStatus_EXCEPTION(status)) {
672 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800673 }
Nick Coghland6009512014-11-20 21:39:37 +1000674
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100675 const PyConfig *config = &tstate->interp->config;
Victor Stinner2ec1a1b2019-11-22 21:54:33 +0100676 if (_Py_IsMainInterpreter(tstate)) {
677 /* Initialize _warnings. */
678 if (_PyWarnings_Init() == NULL) {
679 return _PyStatus_ERR("can't initialize warnings");
680 }
Nick Coghland6009512014-11-20 21:39:37 +1000681
Victor Stinner2ec1a1b2019-11-22 21:54:33 +0100682 if (config->_install_importlib) {
683 status = _PyConfig_WritePathConfig(config);
684 if (_PyStatus_EXCEPTION(status)) {
685 return status;
686 }
Victor Stinnerb1147e42018-07-21 02:06:16 +0200687 }
688 }
689
Eric Snow1abcf672017-05-23 21:46:51 -0700690 /* This call sets up builtin and frozen import support */
Victor Stinnerb45d2592019-06-20 00:05:23 +0200691 if (config->_install_importlib) {
692 status = init_importlib(tstate, sysmod);
Victor Stinner331a6a52019-05-27 16:39:22 +0200693 if (_PyStatus_EXCEPTION(status)) {
694 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800695 }
Eric Snow1abcf672017-05-23 21:46:51 -0700696 }
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100697
698 assert(!_PyErr_Occurred(tstate));
699
Victor Stinner331a6a52019-05-27 16:39:22 +0200700 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100701}
702
703
Victor Stinner331a6a52019-05-27 16:39:22 +0200704static PyStatus
Victor Stinnerd863ade2019-12-06 03:37:07 +0100705pycore_interp_init(PyThreadState *tstate)
706{
707 PyStatus status;
Victor Stinner080ee5a2019-12-08 21:55:58 +0100708 PyObject *sysmod = NULL;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100709
710 status = pycore_init_types(tstate);
711 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100712 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100713 }
714
Victor Stinnerd863ade2019-12-06 03:37:07 +0100715 status = _PySys_Create(tstate, &sysmod);
716 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100717 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100718 }
719
720 status = pycore_init_builtins(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 Stinner080ee5a2019-12-08 21:55:58 +0100725 status = pycore_init_import_warnings(tstate, sysmod);
726
727done:
728 /* sys.modules['sys'] contains a strong reference to the module */
729 Py_XDECREF(sysmod);
730 return status;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100731}
732
733
734static PyStatus
Victor Stinner331a6a52019-05-27 16:39:22 +0200735pyinit_config(_PyRuntimeState *runtime,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200736 PyThreadState **tstate_p,
Victor Stinner331a6a52019-05-27 16:39:22 +0200737 const PyConfig *config)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100738{
Victor Stinner331a6a52019-05-27 16:39:22 +0200739 _PyConfig_Write(config, runtime);
Victor Stinner20004952019-03-26 02:31:11 +0100740
Victor Stinner331a6a52019-05-27 16:39:22 +0200741 PyStatus status = pycore_init_runtime(runtime, config);
742 if (_PyStatus_EXCEPTION(status)) {
743 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100744 }
745
Victor Stinnerb45d2592019-06-20 00:05:23 +0200746 PyThreadState *tstate;
747 status = pycore_create_interpreter(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200748 if (_PyStatus_EXCEPTION(status)) {
749 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100750 }
Victor Stinnerb45d2592019-06-20 00:05:23 +0200751 config = &tstate->interp->config;
752 *tstate_p = tstate;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100753
Victor Stinnerd863ade2019-12-06 03:37:07 +0100754 status = pycore_interp_init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200755 if (_PyStatus_EXCEPTION(status)) {
756 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100757 }
Eric Snow1abcf672017-05-23 21:46:51 -0700758
759 /* Only when we get here is the runtime core fully initialized */
Victor Stinner43125222019-04-24 18:23:53 +0200760 runtime->core_initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200761 return _PyStatus_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700762}
763
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100764
Victor Stinner331a6a52019-05-27 16:39:22 +0200765PyStatus
766_Py_PreInitializeFromPyArgv(const PyPreConfig *src_config, const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100767{
Victor Stinner331a6a52019-05-27 16:39:22 +0200768 PyStatus status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100769
Victor Stinner6d1c4672019-05-20 11:02:00 +0200770 if (src_config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200771 return _PyStatus_ERR("preinitialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +0200772 }
773
Victor Stinner331a6a52019-05-27 16:39:22 +0200774 status = _PyRuntime_Initialize();
775 if (_PyStatus_EXCEPTION(status)) {
776 return status;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100777 }
Victor Stinner43125222019-04-24 18:23:53 +0200778 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100779
Victor Stinnerd3b90412019-09-17 23:59:51 +0200780 if (runtime->preinitialized) {
Victor Stinnerf72346c2019-03-25 17:54:58 +0100781 /* If it's already configured: ignored the new configuration */
Victor Stinner331a6a52019-05-27 16:39:22 +0200782 return _PyStatus_OK();
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100783 }
784
Victor Stinnerd3b90412019-09-17 23:59:51 +0200785 /* Note: preinitialized remains 1 on error, it is only set to 0
786 at exit on success. */
787 runtime->preinitializing = 1;
788
Victor Stinner331a6a52019-05-27 16:39:22 +0200789 PyPreConfig config;
Victor Stinner441b10c2019-09-28 04:28:35 +0200790
791 status = _PyPreConfig_InitFromPreConfig(&config, src_config);
792 if (_PyStatus_EXCEPTION(status)) {
793 return status;
794 }
Victor Stinnerf72346c2019-03-25 17:54:58 +0100795
Victor Stinner331a6a52019-05-27 16:39:22 +0200796 status = _PyPreConfig_Read(&config, args);
797 if (_PyStatus_EXCEPTION(status)) {
798 return status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100799 }
800
Victor Stinner331a6a52019-05-27 16:39:22 +0200801 status = _PyPreConfig_Write(&config);
802 if (_PyStatus_EXCEPTION(status)) {
803 return status;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100804 }
805
Victor Stinnerd3b90412019-09-17 23:59:51 +0200806 runtime->preinitializing = 0;
807 runtime->preinitialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200808 return _PyStatus_OK();
Victor Stinnerf72346c2019-03-25 17:54:58 +0100809}
810
Victor Stinner70005ac2019-05-02 15:25:34 -0400811
Victor Stinner331a6a52019-05-27 16:39:22 +0200812PyStatus
813Py_PreInitializeFromBytesArgs(const PyPreConfig *src_config, Py_ssize_t argc, char **argv)
Victor Stinnerf72346c2019-03-25 17:54:58 +0100814{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100815 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400816 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100817}
818
819
Victor Stinner331a6a52019-05-27 16:39:22 +0200820PyStatus
821Py_PreInitializeFromArgs(const PyPreConfig *src_config, Py_ssize_t argc, wchar_t **argv)
Victor Stinner20004952019-03-26 02:31:11 +0100822{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100823 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400824 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinner20004952019-03-26 02:31:11 +0100825}
826
827
Victor Stinner331a6a52019-05-27 16:39:22 +0200828PyStatus
829Py_PreInitialize(const PyPreConfig *src_config)
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100830{
Victor Stinner70005ac2019-05-02 15:25:34 -0400831 return _Py_PreInitializeFromPyArgv(src_config, NULL);
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100832}
833
834
Victor Stinner331a6a52019-05-27 16:39:22 +0200835PyStatus
836_Py_PreInitializeFromConfig(const PyConfig *config,
837 const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100838{
Victor Stinner331a6a52019-05-27 16:39:22 +0200839 assert(config != NULL);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200840
Victor Stinner331a6a52019-05-27 16:39:22 +0200841 PyStatus status = _PyRuntime_Initialize();
842 if (_PyStatus_EXCEPTION(status)) {
843 return status;
Victor Stinner6d1c4672019-05-20 11:02:00 +0200844 }
845 _PyRuntimeState *runtime = &_PyRuntime;
846
Victor Stinnerd3b90412019-09-17 23:59:51 +0200847 if (runtime->preinitialized) {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200848 /* Already initialized: do nothing */
Victor Stinner331a6a52019-05-27 16:39:22 +0200849 return _PyStatus_OK();
Victor Stinner70005ac2019-05-02 15:25:34 -0400850 }
Victor Stinnercab5d072019-05-17 19:01:14 +0200851
Victor Stinner331a6a52019-05-27 16:39:22 +0200852 PyPreConfig preconfig;
Victor Stinner441b10c2019-09-28 04:28:35 +0200853
Victor Stinner3c30a762019-10-01 10:56:37 +0200854 _PyPreConfig_InitFromConfig(&preconfig, config);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200855
Victor Stinner331a6a52019-05-27 16:39:22 +0200856 if (!config->parse_argv) {
857 return Py_PreInitialize(&preconfig);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200858 }
859 else if (args == NULL) {
Victor Stinnercab5d072019-05-17 19:01:14 +0200860 _PyArgv config_args = {
861 .use_bytes_argv = 0,
Victor Stinner331a6a52019-05-27 16:39:22 +0200862 .argc = config->argv.length,
863 .wchar_argv = config->argv.items};
Victor Stinner6d1c4672019-05-20 11:02:00 +0200864 return _Py_PreInitializeFromPyArgv(&preconfig, &config_args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200865 }
866 else {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200867 return _Py_PreInitializeFromPyArgv(&preconfig, args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200868 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100869}
870
871
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100872/* Begin interpreter initialization
873 *
874 * On return, the first thread and interpreter state have been created,
875 * but the compiler, signal handling, multithreading and
876 * multiple interpreter support, and codec infrastructure are not yet
877 * available.
878 *
879 * The import system will support builtin and frozen modules only.
880 * The only supported io is writing to sys.stderr
881 *
882 * If any operation invoked by this function fails, a fatal error is
883 * issued and the function does not return.
884 *
885 * Any code invoked from this function should *not* assume it has access
886 * to the Python C API (unless the API is explicitly listed as being
887 * safe to call without calling Py_Initialize first)
888 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200889static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200890pyinit_core(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200891 const PyConfig *src_config,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200892 PyThreadState **tstate_p)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200893{
Victor Stinner331a6a52019-05-27 16:39:22 +0200894 PyStatus status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200895
Victor Stinner331a6a52019-05-27 16:39:22 +0200896 status = _Py_PreInitializeFromConfig(src_config, NULL);
897 if (_PyStatus_EXCEPTION(status)) {
898 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200899 }
900
Victor Stinner331a6a52019-05-27 16:39:22 +0200901 PyConfig config;
Victor Stinner8462a492019-10-01 12:06:16 +0200902 _PyConfig_InitCompatConfig(&config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200903
Victor Stinner331a6a52019-05-27 16:39:22 +0200904 status = _PyConfig_Copy(&config, src_config);
905 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200906 goto done;
907 }
908
Victor Stinner331a6a52019-05-27 16:39:22 +0200909 status = PyConfig_Read(&config);
910 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200911 goto done;
912 }
913
914 if (!runtime->core_initialized) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200915 status = pyinit_config(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200916 }
917 else {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200918 status = pyinit_core_reconfigure(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200919 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200920 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200921 goto done;
922 }
923
924done:
Victor Stinner331a6a52019-05-27 16:39:22 +0200925 PyConfig_Clear(&config);
926 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200927}
928
Victor Stinner5ac27a52019-03-27 13:40:14 +0100929
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200930/* Py_Initialize() has already been called: update the main interpreter
931 configuration. Example of bpo-34008: Py_Main() called after
932 Py_Initialize(). */
Victor Stinner331a6a52019-05-27 16:39:22 +0200933static PyStatus
Victor Stinnerb0051362019-11-22 17:52:42 +0100934_Py_ReconfigureMainInterpreter(PyThreadState *tstate)
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200935{
Victor Stinnerb0051362019-11-22 17:52:42 +0100936 PyConfig *config = &tstate->interp->config;
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100937
Victor Stinner331a6a52019-05-27 16:39:22 +0200938 PyObject *argv = _PyWideStringList_AsList(&config->argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100939 if (argv == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200940 return _PyStatus_NO_MEMORY(); \
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100941 }
942
Victor Stinnerb0051362019-11-22 17:52:42 +0100943 int res = PyDict_SetItemString(tstate->interp->sysdict, "argv", argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100944 Py_DECREF(argv);
945 if (res < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200946 return _PyStatus_ERR("fail to set sys.argv");
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200947 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200948 return _PyStatus_OK();
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200949}
950
Victor Stinnerb0051362019-11-22 17:52:42 +0100951
952static PyStatus
953init_interp_main(PyThreadState *tstate)
954{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100955 assert(!_PyErr_Occurred(tstate));
956
Victor Stinnerb0051362019-11-22 17:52:42 +0100957 PyStatus status;
958 int is_main_interp = _Py_IsMainInterpreter(tstate);
959 PyInterpreterState *interp = tstate->interp;
960 PyConfig *config = &interp->config;
961
962 if (!config->_install_importlib) {
963 /* Special mode for freeze_importlib: run with no import system
964 *
965 * This means anything which needs support from extension modules
966 * or pure Python code in the standard library won't work.
967 */
968 if (is_main_interp) {
969 interp->runtime->initialized = 1;
970 }
971 return _PyStatus_OK();
972 }
973
974 if (is_main_interp) {
975 if (_PyTime_Init() < 0) {
976 return _PyStatus_ERR("can't initialize time");
977 }
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100978 }
Victor Stinnerb0051362019-11-22 17:52:42 +0100979
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100980 if (_PySys_InitMain(tstate) < 0) {
981 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerb0051362019-11-22 17:52:42 +0100982 }
983
984 status = init_importlib_external(tstate);
985 if (_PyStatus_EXCEPTION(status)) {
986 return status;
987 }
988
989 if (is_main_interp) {
990 /* initialize the faulthandler module */
991 status = _PyFaulthandler_Init(config->faulthandler);
992 if (_PyStatus_EXCEPTION(status)) {
993 return status;
994 }
995 }
996
997 status = _PyUnicode_InitEncodings(tstate);
998 if (_PyStatus_EXCEPTION(status)) {
999 return status;
1000 }
1001
1002 if (is_main_interp) {
1003 if (config->install_signal_handlers) {
1004 status = init_signals(tstate);
1005 if (_PyStatus_EXCEPTION(status)) {
1006 return status;
1007 }
1008 }
1009
1010 if (_PyTraceMalloc_Init(config->tracemalloc) < 0) {
1011 return _PyStatus_ERR("can't initialize tracemalloc");
1012 }
1013 }
1014
1015 status = init_sys_streams(tstate);
1016 if (_PyStatus_EXCEPTION(status)) {
1017 return status;
1018 }
1019
1020 status = init_set_builtins_open(tstate);
1021 if (_PyStatus_EXCEPTION(status)) {
1022 return status;
1023 }
1024
1025 status = add_main_module(interp);
1026 if (_PyStatus_EXCEPTION(status)) {
1027 return status;
1028 }
1029
1030 if (is_main_interp) {
1031 /* Initialize warnings. */
1032 PyObject *warnoptions = PySys_GetObject("warnoptions");
1033 if (warnoptions != NULL && PyList_Size(warnoptions) > 0)
1034 {
1035 PyObject *warnings_module = PyImport_ImportModule("warnings");
1036 if (warnings_module == NULL) {
1037 fprintf(stderr, "'import warnings' failed; traceback:\n");
1038 _PyErr_Print(tstate);
1039 }
1040 Py_XDECREF(warnings_module);
1041 }
1042
1043 interp->runtime->initialized = 1;
1044 }
1045
1046 if (config->site_import) {
1047 status = init_import_site();
1048 if (_PyStatus_EXCEPTION(status)) {
1049 return status;
1050 }
1051 }
1052
1053 if (is_main_interp) {
1054#ifndef MS_WINDOWS
1055 emit_stderr_warning_for_legacy_locale(interp->runtime);
1056#endif
1057 }
1058
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001059 assert(!_PyErr_Occurred(tstate));
1060
Victor Stinnerb0051362019-11-22 17:52:42 +01001061 return _PyStatus_OK();
1062}
1063
1064
Eric Snowc7ec9982017-05-23 23:00:52 -07001065/* Update interpreter state based on supplied configuration settings
1066 *
1067 * After calling this function, most of the restrictions on the interpreter
1068 * are lifted. The only remaining incomplete settings are those related
1069 * to the main module (sys.argv[0], __main__ metadata)
1070 *
1071 * Calling this when the interpreter is not initializing, is already
1072 * initialized or without a valid current thread state is a fatal error.
1073 * Other errors should be reported as normal Python exceptions with a
1074 * non-zero return code.
1075 */
Victor Stinner331a6a52019-05-27 16:39:22 +02001076static PyStatus
Victor Stinner01b1cc12019-11-20 02:27:56 +01001077pyinit_main(PyThreadState *tstate)
Eric Snow1abcf672017-05-23 21:46:51 -07001078{
Victor Stinnerb0051362019-11-22 17:52:42 +01001079 PyInterpreterState *interp = tstate->interp;
1080 if (!interp->runtime->core_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001081 return _PyStatus_ERR("runtime core not initialized");
Eric Snowc7ec9982017-05-23 23:00:52 -07001082 }
Eric Snowc7ec9982017-05-23 23:00:52 -07001083
Victor Stinnerb0051362019-11-22 17:52:42 +01001084 if (interp->runtime->initialized) {
1085 return _Py_ReconfigureMainInterpreter(tstate);
Victor Stinnerfb47bca2018-07-20 17:34:23 +02001086 }
1087
Victor Stinnerb0051362019-11-22 17:52:42 +01001088 PyStatus status = init_interp_main(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001089 if (_PyStatus_EXCEPTION(status)) {
1090 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001091 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001092 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001093}
1094
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001095
Victor Stinner331a6a52019-05-27 16:39:22 +02001096PyStatus
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001097_Py_InitializeMain(void)
1098{
Victor Stinner331a6a52019-05-27 16:39:22 +02001099 PyStatus status = _PyRuntime_Initialize();
1100 if (_PyStatus_EXCEPTION(status)) {
1101 return status;
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001102 }
1103 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinnerb45d2592019-06-20 00:05:23 +02001104 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
Victor Stinner01b1cc12019-11-20 02:27:56 +01001105 return pyinit_main(tstate);
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001106}
1107
1108
Victor Stinner331a6a52019-05-27 16:39:22 +02001109PyStatus
1110Py_InitializeFromConfig(const PyConfig *config)
Eric Snow1abcf672017-05-23 21:46:51 -07001111{
Victor Stinner6d1c4672019-05-20 11:02:00 +02001112 if (config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001113 return _PyStatus_ERR("initialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +02001114 }
1115
Victor Stinner331a6a52019-05-27 16:39:22 +02001116 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001117
Victor Stinner331a6a52019-05-27 16:39:22 +02001118 status = _PyRuntime_Initialize();
1119 if (_PyStatus_EXCEPTION(status)) {
1120 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001121 }
1122 _PyRuntimeState *runtime = &_PyRuntime;
1123
Victor Stinnerb45d2592019-06-20 00:05:23 +02001124 PyThreadState *tstate = NULL;
1125 status = pyinit_core(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001126 if (_PyStatus_EXCEPTION(status)) {
1127 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001128 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02001129 config = &tstate->interp->config;
Victor Stinnerbc8ac6b2017-11-30 18:03:55 +01001130
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001131 if (config->_init_main) {
Victor Stinner01b1cc12019-11-20 02:27:56 +01001132 status = pyinit_main(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001133 if (_PyStatus_EXCEPTION(status)) {
1134 return status;
Victor Stinner484f20d2019-03-27 02:04:16 +01001135 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001136 }
Victor Stinner484f20d2019-03-27 02:04:16 +01001137
Victor Stinner331a6a52019-05-27 16:39:22 +02001138 return _PyStatus_OK();
Victor Stinner5ac27a52019-03-27 13:40:14 +01001139}
1140
1141
Eric Snow1abcf672017-05-23 21:46:51 -07001142void
Nick Coghland6009512014-11-20 21:39:37 +10001143Py_InitializeEx(int install_sigs)
1144{
Victor Stinner331a6a52019-05-27 16:39:22 +02001145 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001146
Victor Stinner331a6a52019-05-27 16:39:22 +02001147 status = _PyRuntime_Initialize();
1148 if (_PyStatus_EXCEPTION(status)) {
1149 Py_ExitStatusException(status);
Victor Stinner43125222019-04-24 18:23:53 +02001150 }
1151 _PyRuntimeState *runtime = &_PyRuntime;
1152
1153 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001154 /* bpo-33932: Calling Py_Initialize() twice does nothing. */
1155 return;
1156 }
1157
Victor Stinner331a6a52019-05-27 16:39:22 +02001158 PyConfig config;
Victor Stinner8462a492019-10-01 12:06:16 +02001159 _PyConfig_InitCompatConfig(&config);
Victor Stinner441b10c2019-09-28 04:28:35 +02001160
Victor Stinner1dc6e392018-07-25 02:49:17 +02001161 config.install_signal_handlers = install_sigs;
1162
Victor Stinner331a6a52019-05-27 16:39:22 +02001163 status = Py_InitializeFromConfig(&config);
1164 if (_PyStatus_EXCEPTION(status)) {
1165 Py_ExitStatusException(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001166 }
Nick Coghland6009512014-11-20 21:39:37 +10001167}
1168
1169void
1170Py_Initialize(void)
1171{
1172 Py_InitializeEx(1);
1173}
1174
1175
1176#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001177extern void _Py_dump_counts(FILE*);
Nick Coghland6009512014-11-20 21:39:37 +10001178#endif
1179
1180/* Flush stdout and stderr */
1181
1182static int
1183file_is_closed(PyObject *fobj)
1184{
1185 int r;
1186 PyObject *tmp = PyObject_GetAttrString(fobj, "closed");
1187 if (tmp == NULL) {
1188 PyErr_Clear();
1189 return 0;
1190 }
1191 r = PyObject_IsTrue(tmp);
1192 Py_DECREF(tmp);
1193 if (r < 0)
1194 PyErr_Clear();
1195 return r > 0;
1196}
1197
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001198static int
Nick Coghland6009512014-11-20 21:39:37 +10001199flush_std_files(void)
1200{
1201 PyObject *fout = _PySys_GetObjectId(&PyId_stdout);
1202 PyObject *ferr = _PySys_GetObjectId(&PyId_stderr);
1203 PyObject *tmp;
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001204 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001205
1206 if (fout != NULL && fout != Py_None && !file_is_closed(fout)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001207 tmp = _PyObject_CallMethodIdNoArgs(fout, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001208 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001209 PyErr_WriteUnraisable(fout);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001210 status = -1;
1211 }
Nick Coghland6009512014-11-20 21:39:37 +10001212 else
1213 Py_DECREF(tmp);
1214 }
1215
1216 if (ferr != NULL && ferr != Py_None && !file_is_closed(ferr)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001217 tmp = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001218 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001219 PyErr_Clear();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001220 status = -1;
1221 }
Nick Coghland6009512014-11-20 21:39:37 +10001222 else
1223 Py_DECREF(tmp);
1224 }
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001225
1226 return status;
Nick Coghland6009512014-11-20 21:39:37 +10001227}
1228
1229/* Undo the effect of Py_Initialize().
1230
1231 Beware: if multiple interpreter and/or thread states exist, these
1232 are not wiped out; only the current thread and interpreter state
1233 are deleted. But since everything else is deleted, those other
1234 interpreter and thread states should no longer be used.
1235
1236 (XXX We should do better, e.g. wipe out all interpreters and
1237 threads.)
1238
1239 Locking: as above.
1240
1241*/
1242
Victor Stinner7eee5be2019-11-20 10:38:34 +01001243
1244static void
1245finalize_interp_types(PyThreadState *tstate, int is_main_interp)
1246{
1247 if (is_main_interp) {
1248 /* Sundry finalizers */
Victor Stinner7eee5be2019-11-20 10:38:34 +01001249 _PyFrame_Fini();
Victor Stinner7eee5be2019-11-20 10:38:34 +01001250 _PyTuple_Fini();
1251 _PyList_Fini();
1252 _PySet_Fini();
1253 _PyBytes_Fini();
1254 _PyLong_Fini();
1255 _PyFloat_Fini();
1256 _PyDict_Fini();
1257 _PySlice_Fini();
1258 }
1259
1260 _PyWarnings_Fini(tstate->interp);
1261
1262 if (is_main_interp) {
1263 _Py_HashRandomization_Fini();
1264 _PyArg_Fini();
1265 _PyAsyncGen_Fini();
1266 _PyContext_Fini();
Victor Stinner3d483342019-11-22 12:27:50 +01001267 }
Victor Stinner7eee5be2019-11-20 10:38:34 +01001268
Victor Stinner3d483342019-11-22 12:27:50 +01001269 /* Cleanup Unicode implementation */
1270 _PyUnicode_Fini(tstate);
1271
1272 if (is_main_interp) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001273 _Py_ClearFileSystemEncoding();
1274 }
1275}
1276
1277
1278static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001279finalize_interp_clear(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001280{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001281 int is_main_interp = _Py_IsMainInterpreter(tstate);
1282
Victor Stinner7eee5be2019-11-20 10:38:34 +01001283 /* Clear interpreter state and all thread states */
1284 PyInterpreterState_Clear(tstate->interp);
1285
Pablo Galindoac0e1c22019-12-04 11:51:03 +00001286 /* Trigger a GC collection on subinterpreters*/
1287 if (!is_main_interp) {
1288 _PyGC_CollectNoFail();
1289 }
1290
Victor Stinner7eee5be2019-11-20 10:38:34 +01001291 finalize_interp_types(tstate, is_main_interp);
1292
1293 if (is_main_interp) {
1294 /* XXX Still allocated:
1295 - various static ad-hoc pointers to interned strings
1296 - int and float free list blocks
1297 - whatever various modules and libraries allocate
1298 */
1299
1300 PyGrammar_RemoveAccelerators(&_PyParser_Grammar);
1301
1302 _PyExc_Fini();
Victor Stinner7eee5be2019-11-20 10:38:34 +01001303 }
Victor Stinner72474072019-11-20 12:25:50 +01001304
1305 _PyGC_Fini(tstate);
Victor Stinner7eee5be2019-11-20 10:38:34 +01001306}
1307
1308
1309static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001310finalize_interp_delete(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001311{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001312 if (_Py_IsMainInterpreter(tstate)) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001313 /* Cleanup auto-thread-state */
1314 _PyGILState_Fini(tstate);
1315 }
1316
Victor Stinner7eee5be2019-11-20 10:38:34 +01001317 PyInterpreterState_Delete(tstate->interp);
1318}
1319
1320
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001321int
1322Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001323{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001324 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001325
Victor Stinner8e91c242019-04-24 17:24:01 +02001326 _PyRuntimeState *runtime = &_PyRuntime;
1327 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001328 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001329 }
Nick Coghland6009512014-11-20 21:39:37 +10001330
Victor Stinnere225beb2019-06-03 18:14:24 +02001331 /* Get current thread state and interpreter pointer */
1332 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
1333 PyInterpreterState *interp = tstate->interp;
Victor Stinner8e91c242019-04-24 17:24:01 +02001334
Victor Stinnerb45d2592019-06-20 00:05:23 +02001335 // Wrap up existing "threading"-module-created, non-daemon threads.
1336 wait_for_thread_shutdown(tstate);
1337
1338 // Make any remaining pending calls.
1339 _Py_FinishPendingCalls(runtime);
1340
Nick Coghland6009512014-11-20 21:39:37 +10001341 /* The interpreter is still entirely intact at this point, and the
1342 * exit funcs may be relying on that. In particular, if some thread
1343 * or exit func is still waiting to do an import, the import machinery
1344 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001345 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001346 * Note that Threading.py uses an exit func to do a join on all the
1347 * threads created thru it, so this also protects pending imports in
1348 * the threads created via Threading.
1349 */
Nick Coghland6009512014-11-20 21:39:37 +10001350
Victor Stinnerb45d2592019-06-20 00:05:23 +02001351 call_py_exitfuncs(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001352
Victor Stinnerda273412017-12-15 01:46:02 +01001353 /* Copy the core config, PyInterpreterState_Delete() free
1354 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001355#ifdef Py_REF_DEBUG
Victor Stinner331a6a52019-05-27 16:39:22 +02001356 int show_ref_count = interp->config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001357#endif
1358#ifdef Py_TRACE_REFS
Victor Stinner331a6a52019-05-27 16:39:22 +02001359 int dump_refs = interp->config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001360#endif
1361#ifdef WITH_PYMALLOC
Victor Stinner331a6a52019-05-27 16:39:22 +02001362 int malloc_stats = interp->config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001363#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001364
Nick Coghland6009512014-11-20 21:39:37 +10001365 /* Remaining threads (e.g. daemon threads) will automatically exit
1366 after taking the GIL (in PyEval_RestoreThread()). */
Victor Stinner8e91c242019-04-24 17:24:01 +02001367 runtime->finalizing = tstate;
1368 runtime->initialized = 0;
1369 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001370
Victor Stinnere0deff32015-03-24 13:46:18 +01001371 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001372 if (flush_std_files() < 0) {
1373 status = -1;
1374 }
Nick Coghland6009512014-11-20 21:39:37 +10001375
1376 /* Disable signal handling */
1377 PyOS_FiniInterrupts();
1378
1379 /* Collect garbage. This may call finalizers; it's nice to call these
1380 * before all modules are destroyed.
1381 * XXX If a __del__ or weakref callback is triggered here, and tries to
1382 * XXX import a module, bad things can happen, because Python no
1383 * XXX longer believes it's initialized.
1384 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1385 * XXX is easy to provoke that way. I've also seen, e.g.,
1386 * XXX Exception exceptions.ImportError: 'No module named sha'
1387 * XXX in <function callback at 0x008F5718> ignored
1388 * XXX but I'm unclear on exactly how that one happens. In any case,
1389 * XXX I haven't seen a real-life report of either of these.
1390 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001391 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001392#ifdef COUNT_ALLOCS
1393 /* With COUNT_ALLOCS, it helps to run GC multiple times:
1394 each collection might release some types from the type
1395 list, so they become garbage. */
Łukasz Langafef7e942016-09-09 21:47:46 -07001396 while (_PyGC_CollectIfEnabled() > 0)
Nick Coghland6009512014-11-20 21:39:37 +10001397 /* nothing */;
1398#endif
Eric Snowdae02762017-09-14 00:35:58 -07001399
Steve Dowerb82e17e2019-05-23 08:45:22 -07001400 /* Clear all loghooks */
1401 /* We want minimal exposure of this function, so define the extern
1402 * here. The linker should discover the correct function without
1403 * exporting a symbol. */
1404 extern void _PySys_ClearAuditHooks(void);
1405 _PySys_ClearAuditHooks();
1406
Nick Coghland6009512014-11-20 21:39:37 +10001407 /* Destroy all modules */
Victor Stinner987a0dc2019-06-19 10:36:10 +02001408 _PyImport_Cleanup(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001409
Inada Naoki91234a12019-06-03 21:30:58 +09001410 /* Print debug stats if any */
1411 _PyEval_Fini();
1412
Victor Stinnere0deff32015-03-24 13:46:18 +01001413 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001414 if (flush_std_files() < 0) {
1415 status = -1;
1416 }
Nick Coghland6009512014-11-20 21:39:37 +10001417
1418 /* Collect final garbage. This disposes of cycles created by
1419 * class definitions, for example.
1420 * XXX This is disabled because it caused too many problems. If
1421 * XXX a __del__ or weakref callback triggers here, Python code has
1422 * XXX a hard time running, because even the sys module has been
1423 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1424 * XXX One symptom is a sequence of information-free messages
1425 * XXX coming from threads (if a __del__ or callback is invoked,
1426 * XXX other threads can execute too, and any exception they encounter
1427 * XXX triggers a comedy of errors as subsystem after subsystem
1428 * XXX fails to find what it *expects* to find in sys to help report
1429 * XXX the exception and consequent unexpected failures). I've also
1430 * XXX seen segfaults then, after adding print statements to the
1431 * XXX Python code getting called.
1432 */
1433#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001434 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001435#endif
1436
1437 /* Disable tracemalloc after all Python objects have been destroyed,
1438 so it is possible to use tracemalloc in objects destructor. */
1439 _PyTraceMalloc_Fini();
1440
1441 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1442 _PyImport_Fini();
1443
1444 /* Cleanup typeobject.c's internal caches. */
1445 _PyType_Fini();
1446
1447 /* unload faulthandler module */
1448 _PyFaulthandler_Fini();
1449
1450 /* Debugging stuff */
1451#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001452 _Py_dump_counts(stderr);
Nick Coghland6009512014-11-20 21:39:37 +10001453#endif
1454 /* dump hash stats */
1455 _PyHash_Fini();
1456
Eric Snowdae02762017-09-14 00:35:58 -07001457#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001458 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001459 _PyDebug_PrintTotalRefs();
1460 }
Eric Snowdae02762017-09-14 00:35:58 -07001461#endif
Nick Coghland6009512014-11-20 21:39:37 +10001462
1463#ifdef Py_TRACE_REFS
1464 /* Display all objects still alive -- this can invoke arbitrary
1465 * __repr__ overrides, so requires a mostly-intact interpreter.
1466 * Alas, a lot of stuff may still be alive now that will be cleaned
1467 * up later.
1468 */
Victor Stinnerda273412017-12-15 01:46:02 +01001469 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001470 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001471 }
Nick Coghland6009512014-11-20 21:39:37 +10001472#endif /* Py_TRACE_REFS */
1473
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001474 finalize_interp_clear(tstate);
1475 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001476
1477#ifdef Py_TRACE_REFS
1478 /* Display addresses (& refcnts) of all objects still alive.
1479 * An address can be used to find the repr of the object, printed
1480 * above by _Py_PrintReferences.
1481 */
Victor Stinnerda273412017-12-15 01:46:02 +01001482 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001483 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001484 }
Nick Coghland6009512014-11-20 21:39:37 +10001485#endif /* Py_TRACE_REFS */
Victor Stinner34be8072016-03-14 12:04:26 +01001486#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001487 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001488 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be8072016-03-14 12:04:26 +01001489 }
Nick Coghland6009512014-11-20 21:39:37 +10001490#endif
1491
Victor Stinner8e91c242019-04-24 17:24:01 +02001492 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001493
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001494 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001495 return status;
1496}
1497
1498void
1499Py_Finalize(void)
1500{
1501 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001502}
1503
Victor Stinnerb0051362019-11-22 17:52:42 +01001504
Nick Coghland6009512014-11-20 21:39:37 +10001505/* Create and initialize a new interpreter and thread, and return the
1506 new thread. This requires that Py_Initialize() has been called
1507 first.
1508
1509 Unsuccessful initialization yields a NULL pointer. Note that *no*
1510 exception information is available even in this case -- the
1511 exception information is held in the thread, and there is no
1512 thread.
1513
1514 Locking: as above.
1515
1516*/
1517
Victor Stinner331a6a52019-05-27 16:39:22 +02001518static PyStatus
Victor Stinnera7368ac2017-11-15 18:11:45 -08001519new_interpreter(PyThreadState **tstate_p)
Nick Coghland6009512014-11-20 21:39:37 +10001520{
Victor Stinner331a6a52019-05-27 16:39:22 +02001521 PyStatus status;
Nick Coghland6009512014-11-20 21:39:37 +10001522
Victor Stinner331a6a52019-05-27 16:39:22 +02001523 status = _PyRuntime_Initialize();
1524 if (_PyStatus_EXCEPTION(status)) {
1525 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001526 }
1527 _PyRuntimeState *runtime = &_PyRuntime;
1528
1529 if (!runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001530 return _PyStatus_ERR("Py_Initialize must be called first");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001531 }
Nick Coghland6009512014-11-20 21:39:37 +10001532
Victor Stinner8a1be612016-03-14 22:07:55 +01001533 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1534 interpreters: disable PyGILState_Check(). */
1535 _PyGILState_check_enabled = 0;
1536
Victor Stinner43125222019-04-24 18:23:53 +02001537 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001538 if (interp == NULL) {
1539 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001540 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001541 }
Nick Coghland6009512014-11-20 21:39:37 +10001542
Victor Stinner43125222019-04-24 18:23:53 +02001543 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001544 if (tstate == NULL) {
1545 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001546 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001547 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001548 }
1549
Victor Stinner43125222019-04-24 18:23:53 +02001550 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001551
Eric Snow1abcf672017-05-23 21:46:51 -07001552 /* Copy the current interpreter config into the new interpreter */
Victor Stinner331a6a52019-05-27 16:39:22 +02001553 PyConfig *config;
Eric Snow1abcf672017-05-23 21:46:51 -07001554 if (save_tstate != NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001555 config = &save_tstate->interp->config;
Eric Snow1abcf672017-05-23 21:46:51 -07001556 } else {
1557 /* No current thread state, copy from the main interpreter */
1558 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinner331a6a52019-05-27 16:39:22 +02001559 config = &main_interp->config;
Victor Stinnerda273412017-12-15 01:46:02 +01001560 }
1561
Victor Stinner331a6a52019-05-27 16:39:22 +02001562 status = _PyConfig_Copy(&interp->config, config);
1563 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001564 goto error;
Victor Stinnerda273412017-12-15 01:46:02 +01001565 }
Eric Snow1abcf672017-05-23 21:46:51 -07001566
Victor Stinnerd863ade2019-12-06 03:37:07 +01001567 status = pycore_interp_init(tstate);
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001568 if (_PyStatus_EXCEPTION(status)) {
1569 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001570 }
1571
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001572 status = init_interp_main(tstate);
1573 if (_PyStatus_EXCEPTION(status)) {
1574 goto error;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001575 }
Nick Coghland6009512014-11-20 21:39:37 +10001576
Victor Stinnera7368ac2017-11-15 18:11:45 -08001577 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +02001578 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001579
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001580error:
Victor Stinnerb0051362019-11-22 17:52:42 +01001581 *tstate_p = NULL;
1582
1583 /* Oops, it didn't work. Undo it all. */
Nick Coghland6009512014-11-20 21:39:37 +10001584 PyErr_PrintEx(0);
1585 PyThreadState_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001586 PyThreadState_Delete(tstate);
1587 PyInterpreterState_Delete(interp);
Victor Stinner9da74302019-11-20 11:17:17 +01001588 PyThreadState_Swap(save_tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001589
Victor Stinnerb0051362019-11-22 17:52:42 +01001590 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001591}
1592
1593PyThreadState *
1594Py_NewInterpreter(void)
1595{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001596 PyThreadState *tstate = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001597 PyStatus status = new_interpreter(&tstate);
1598 if (_PyStatus_EXCEPTION(status)) {
1599 Py_ExitStatusException(status);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001600 }
1601 return tstate;
1602
Nick Coghland6009512014-11-20 21:39:37 +10001603}
1604
1605/* Delete an interpreter and its last thread. This requires that the
1606 given thread state is current, that the thread has no remaining
1607 frames, and that it is its interpreter's only remaining thread.
1608 It is a fatal error to violate these constraints.
1609
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001610 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001611 everything, regardless.)
1612
1613 Locking: as above.
1614
1615*/
1616
1617void
1618Py_EndInterpreter(PyThreadState *tstate)
1619{
1620 PyInterpreterState *interp = tstate->interp;
1621
Victor Stinnerb45d2592019-06-20 00:05:23 +02001622 if (tstate != _PyThreadState_GET()) {
Nick Coghland6009512014-11-20 21:39:37 +10001623 Py_FatalError("Py_EndInterpreter: thread is not current");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001624 }
1625 if (tstate->frame != NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001626 Py_FatalError("Py_EndInterpreter: thread still has a frame");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001627 }
Eric Snow5be45a62019-03-08 22:47:07 -07001628 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001629
Eric Snow842a2f02019-03-15 15:47:51 -06001630 // Wrap up existing "threading"-module-created, non-daemon threads.
Victor Stinnerb45d2592019-06-20 00:05:23 +02001631 wait_for_thread_shutdown(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001632
Victor Stinnerb45d2592019-06-20 00:05:23 +02001633 call_py_exitfuncs(tstate);
Marcel Plch776407f2017-12-20 11:17:58 +01001634
Victor Stinnerb45d2592019-06-20 00:05:23 +02001635 if (tstate != interp->tstate_head || tstate->next != NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001636 Py_FatalError("Py_EndInterpreter: not the last thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001637 }
Nick Coghland6009512014-11-20 21:39:37 +10001638
Victor Stinner987a0dc2019-06-19 10:36:10 +02001639 _PyImport_Cleanup(tstate);
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001640 finalize_interp_clear(tstate);
1641 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001642}
1643
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001644/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001645
Victor Stinner331a6a52019-05-27 16:39:22 +02001646static PyStatus
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001647add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001648{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001649 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001650 m = PyImport_AddModule("__main__");
1651 if (m == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +02001652 return _PyStatus_ERR("can't create __main__ module");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001653
Nick Coghland6009512014-11-20 21:39:37 +10001654 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001655 ann_dict = PyDict_New();
1656 if ((ann_dict == NULL) ||
1657 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001658 return _PyStatus_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001659 }
1660 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001661
Nick Coghland6009512014-11-20 21:39:37 +10001662 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1663 PyObject *bimod = PyImport_ImportModule("builtins");
1664 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001665 return _PyStatus_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001666 }
1667 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001668 return _PyStatus_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001669 }
1670 Py_DECREF(bimod);
1671 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001672
Nick Coghland6009512014-11-20 21:39:37 +10001673 /* Main is a little special - imp.is_builtin("__main__") will return
1674 * False, but BuiltinImporter is still the most appropriate initial
1675 * setting for its __loader__ attribute. A more suitable value will
1676 * be set if __main__ gets further initialized later in the startup
1677 * process.
1678 */
1679 loader = PyDict_GetItemString(d, "__loader__");
1680 if (loader == NULL || loader == Py_None) {
1681 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1682 "BuiltinImporter");
1683 if (loader == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001684 return _PyStatus_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001685 }
1686 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001687 return _PyStatus_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001688 }
1689 Py_DECREF(loader);
1690 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001691 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001692}
1693
Nick Coghland6009512014-11-20 21:39:37 +10001694/* Import the site module (not into __main__ though) */
1695
Victor Stinner331a6a52019-05-27 16:39:22 +02001696static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001697init_import_site(void)
Nick Coghland6009512014-11-20 21:39:37 +10001698{
1699 PyObject *m;
1700 m = PyImport_ImportModule("site");
1701 if (m == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001702 return _PyStatus_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001703 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001704 Py_DECREF(m);
Victor Stinner331a6a52019-05-27 16:39:22 +02001705 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001706}
1707
Victor Stinner874dbe82015-09-04 17:29:57 +02001708/* Check if a file descriptor is valid or not.
1709 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1710static int
1711is_valid_fd(int fd)
1712{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001713/* dup() is faster than fstat(): fstat() can require input/output operations,
1714 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1715 startup. Problem: dup() doesn't check if the file descriptor is valid on
1716 some platforms.
1717
1718 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1719 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1720 EBADF. FreeBSD has similar issue (bpo-32849).
1721
1722 Only use dup() on platforms where dup() is enough to detect invalid FD in
1723 corner cases: on Linux and Windows (bpo-32849). */
1724#if defined(__linux__) || defined(MS_WINDOWS)
1725 if (fd < 0) {
1726 return 0;
1727 }
1728 int fd2;
1729
1730 _Py_BEGIN_SUPPRESS_IPH
1731 fd2 = dup(fd);
1732 if (fd2 >= 0) {
1733 close(fd2);
1734 }
1735 _Py_END_SUPPRESS_IPH
1736
1737 return (fd2 >= 0);
1738#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001739 struct stat st;
1740 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001741#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001742}
1743
1744/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001745static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02001746create_stdio(const PyConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001747 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001748 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001749{
1750 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1751 const char* mode;
1752 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001753 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001754 int buffering, isatty;
1755 _Py_IDENTIFIER(open);
1756 _Py_IDENTIFIER(isatty);
1757 _Py_IDENTIFIER(TextIOWrapper);
1758 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001759 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001760
Victor Stinner874dbe82015-09-04 17:29:57 +02001761 if (!is_valid_fd(fd))
1762 Py_RETURN_NONE;
1763
Nick Coghland6009512014-11-20 21:39:37 +10001764 /* stdin is always opened in buffered mode, first because it shouldn't
1765 make a difference in common use cases, second because TextIOWrapper
1766 depends on the presence of a read1() method which only exists on
1767 buffered streams.
1768 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001769 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001770 buffering = 0;
1771 else
1772 buffering = -1;
1773 if (write_mode)
1774 mode = "wb";
1775 else
1776 mode = "rb";
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001777 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOO",
Nick Coghland6009512014-11-20 21:39:37 +10001778 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001779 Py_None, Py_None, /* encoding, errors */
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001780 Py_None, Py_False); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001781 if (buf == NULL)
1782 goto error;
1783
1784 if (buffering) {
1785 _Py_IDENTIFIER(raw);
1786 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1787 if (raw == NULL)
1788 goto error;
1789 }
1790 else {
1791 raw = buf;
1792 Py_INCREF(raw);
1793 }
1794
Steve Dower39294992016-08-30 21:22:36 -07001795#ifdef MS_WINDOWS
1796 /* Windows console IO is always UTF-8 encoded */
1797 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001798 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001799#endif
1800
Nick Coghland6009512014-11-20 21:39:37 +10001801 text = PyUnicode_FromString(name);
1802 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1803 goto error;
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001804 res = _PyObject_CallMethodIdNoArgs(raw, &PyId_isatty);
Nick Coghland6009512014-11-20 21:39:37 +10001805 if (res == NULL)
1806 goto error;
1807 isatty = PyObject_IsTrue(res);
1808 Py_DECREF(res);
1809 if (isatty == -1)
1810 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001811 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001812 write_through = Py_True;
1813 else
1814 write_through = Py_False;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001815 if (isatty && buffered_stdio)
Nick Coghland6009512014-11-20 21:39:37 +10001816 line_buffering = Py_True;
1817 else
1818 line_buffering = Py_False;
1819
1820 Py_CLEAR(raw);
1821 Py_CLEAR(text);
1822
1823#ifdef MS_WINDOWS
1824 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1825 newlines to "\n".
1826 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1827 newline = NULL;
1828#else
1829 /* sys.stdin: split lines at "\n".
1830 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1831 newline = "\n";
1832#endif
1833
Victor Stinner709d23d2019-05-02 14:56:30 -04001834 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1835 if (encoding_str == NULL) {
1836 Py_CLEAR(buf);
1837 goto error;
1838 }
1839
1840 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1841 if (errors_str == NULL) {
1842 Py_CLEAR(buf);
1843 Py_CLEAR(encoding_str);
1844 goto error;
1845 }
1846
1847 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1848 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001849 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001850 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001851 Py_CLEAR(encoding_str);
1852 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001853 if (stream == NULL)
1854 goto error;
1855
1856 if (write_mode)
1857 mode = "w";
1858 else
1859 mode = "r";
1860 text = PyUnicode_FromString(mode);
1861 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1862 goto error;
1863 Py_CLEAR(text);
1864 return stream;
1865
1866error:
1867 Py_XDECREF(buf);
1868 Py_XDECREF(stream);
1869 Py_XDECREF(text);
1870 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001871
Victor Stinner874dbe82015-09-04 17:29:57 +02001872 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1873 /* Issue #24891: the file descriptor was closed after the first
1874 is_valid_fd() check was called. Ignore the OSError and set the
1875 stream to None. */
1876 PyErr_Clear();
1877 Py_RETURN_NONE;
1878 }
1879 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001880}
1881
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001882/* Set builtins.open to io.OpenWrapper */
1883static PyStatus
1884init_set_builtins_open(PyThreadState *tstate)
1885{
1886 PyObject *iomod = NULL, *wrapper;
1887 PyObject *bimod = NULL;
1888 PyStatus res = _PyStatus_OK();
1889
1890 if (!(iomod = PyImport_ImportModule("io"))) {
1891 goto error;
1892 }
1893
1894 if (!(bimod = PyImport_ImportModule("builtins"))) {
1895 goto error;
1896 }
1897
1898 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1899 goto error;
1900 }
1901
1902 /* Set builtins.open */
1903 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1904 Py_DECREF(wrapper);
1905 goto error;
1906 }
1907 Py_DECREF(wrapper);
1908 goto done;
1909
1910error:
1911 res = _PyStatus_ERR("can't initialize io.open");
1912
1913done:
1914 Py_XDECREF(bimod);
1915 Py_XDECREF(iomod);
1916 return res;
1917}
1918
1919
Nick Coghland6009512014-11-20 21:39:37 +10001920/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinner331a6a52019-05-27 16:39:22 +02001921static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001922init_sys_streams(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10001923{
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001924 PyObject *iomod = NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001925 PyObject *m;
1926 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001927 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001928 PyObject * encoding_attr;
Victor Stinner331a6a52019-05-27 16:39:22 +02001929 PyStatus res = _PyStatus_OK();
Victor Stinnerb45d2592019-06-20 00:05:23 +02001930 const PyConfig *config = &tstate->interp->config;
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001931
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001932 /* Check that stdin is not a directory
1933 Using shell redirection, you can redirect stdin to a directory,
1934 crashing the Python interpreter. Catch this common mistake here
1935 and output a useful error message. Note that under MS Windows,
1936 the shell already prevents that. */
1937#ifndef MS_WINDOWS
1938 struct _Py_stat_struct sb;
1939 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1940 S_ISDIR(sb.st_mode)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001941 return _PyStatus_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001942 }
1943#endif
1944
Nick Coghland6009512014-11-20 21:39:37 +10001945 /* Hack to avoid a nasty recursion issue when Python is invoked
1946 in verbose mode: pre-import the Latin-1 and UTF-8 codecs */
1947 if ((m = PyImport_ImportModule("encodings.utf_8")) == NULL) {
1948 goto error;
1949 }
1950 Py_DECREF(m);
1951
1952 if (!(m = PyImport_ImportModule("encodings.latin_1"))) {
1953 goto error;
1954 }
1955 Py_DECREF(m);
1956
Nick Coghland6009512014-11-20 21:39:37 +10001957 if (!(iomod = PyImport_ImportModule("io"))) {
1958 goto error;
1959 }
Nick Coghland6009512014-11-20 21:39:37 +10001960
Nick Coghland6009512014-11-20 21:39:37 +10001961 /* Set sys.stdin */
1962 fd = fileno(stdin);
1963 /* Under some conditions stdin, stdout and stderr may not be connected
1964 * and fileno() may point to an invalid file descriptor. For example
1965 * GUI apps don't have valid standard streams by default.
1966 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001967 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001968 config->stdio_encoding,
1969 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001970 if (std == NULL)
1971 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001972 PySys_SetObject("__stdin__", std);
1973 _PySys_SetObjectId(&PyId_stdin, std);
1974 Py_DECREF(std);
1975
1976 /* Set sys.stdout */
1977 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001978 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001979 config->stdio_encoding,
1980 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001981 if (std == NULL)
1982 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001983 PySys_SetObject("__stdout__", std);
1984 _PySys_SetObjectId(&PyId_stdout, std);
1985 Py_DECREF(std);
1986
1987#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
1988 /* Set sys.stderr, replaces the preliminary stderr */
1989 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001990 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001991 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04001992 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02001993 if (std == NULL)
1994 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001995
1996 /* Same as hack above, pre-import stderr's codec to avoid recursion
1997 when import.c tries to write to stderr in verbose mode. */
1998 encoding_attr = PyObject_GetAttrString(std, "encoding");
1999 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02002000 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10002001 if (std_encoding != NULL) {
2002 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
2003 Py_XDECREF(codec_info);
2004 }
2005 Py_DECREF(encoding_attr);
2006 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02002007 _PyErr_Clear(tstate); /* Not a fatal error if codec isn't available */
Nick Coghland6009512014-11-20 21:39:37 +10002008
2009 if (PySys_SetObject("__stderr__", std) < 0) {
2010 Py_DECREF(std);
2011 goto error;
2012 }
2013 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
2014 Py_DECREF(std);
2015 goto error;
2016 }
2017 Py_DECREF(std);
2018#endif
2019
Victor Stinnera7368ac2017-11-15 18:11:45 -08002020 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10002021
Victor Stinnera7368ac2017-11-15 18:11:45 -08002022error:
Victor Stinner331a6a52019-05-27 16:39:22 +02002023 res = _PyStatus_ERR("can't initialize sys standard streams");
Victor Stinnera7368ac2017-11-15 18:11:45 -08002024
2025done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02002026 _Py_ClearStandardStreamEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10002027 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08002028 return res;
Nick Coghland6009512014-11-20 21:39:37 +10002029}
2030
2031
Victor Stinner10dc4842015-03-24 12:01:30 +01002032static void
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002033_Py_FatalError_DumpTracebacks(int fd, PyInterpreterState *interp,
2034 PyThreadState *tstate)
Victor Stinner10dc4842015-03-24 12:01:30 +01002035{
Victor Stinner10dc4842015-03-24 12:01:30 +01002036 fputc('\n', stderr);
2037 fflush(stderr);
2038
2039 /* display the current Python stack */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002040 _Py_DumpTracebackThreads(fd, interp, tstate);
Victor Stinner10dc4842015-03-24 12:01:30 +01002041}
Victor Stinner791da1c2016-03-14 16:53:12 +01002042
2043/* Print the current exception (if an exception is set) with its traceback,
2044 or display the current Python stack.
2045
2046 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
2047 called on catastrophic cases.
2048
2049 Return 1 if the traceback was displayed, 0 otherwise. */
2050
2051static int
2052_Py_FatalError_PrintExc(int fd)
2053{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002054 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner791da1c2016-03-14 16:53:12 +01002055 PyObject *ferr, *res;
2056 PyObject *exception, *v, *tb;
2057 int has_tb;
2058
Victor Stinnerb45d2592019-06-20 00:05:23 +02002059 _PyErr_Fetch(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002060 if (exception == NULL) {
2061 /* No current exception */
2062 return 0;
2063 }
2064
2065 ferr = _PySys_GetObjectId(&PyId_stderr);
2066 if (ferr == NULL || ferr == Py_None) {
2067 /* sys.stderr is not set yet or set to None,
2068 no need to try to display the exception */
2069 return 0;
2070 }
2071
Victor Stinnerb45d2592019-06-20 00:05:23 +02002072 _PyErr_NormalizeException(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002073 if (tb == NULL) {
2074 tb = Py_None;
2075 Py_INCREF(tb);
2076 }
2077 PyException_SetTraceback(v, tb);
2078 if (exception == NULL) {
2079 /* PyErr_NormalizeException() failed */
2080 return 0;
2081 }
2082
2083 has_tb = (tb != Py_None);
2084 PyErr_Display(exception, v, tb);
2085 Py_XDECREF(exception);
2086 Py_XDECREF(v);
2087 Py_XDECREF(tb);
2088
2089 /* sys.stderr may be buffered: call sys.stderr.flush() */
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002090 res = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002091 if (res == NULL) {
2092 _PyErr_Clear(tstate);
2093 }
2094 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002095 Py_DECREF(res);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002096 }
Victor Stinner791da1c2016-03-14 16:53:12 +01002097
2098 return has_tb;
2099}
2100
Nick Coghland6009512014-11-20 21:39:37 +10002101/* Print fatal error message and abort */
2102
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002103#ifdef MS_WINDOWS
2104static void
2105fatal_output_debug(const char *msg)
2106{
2107 /* buffer of 256 bytes allocated on the stack */
2108 WCHAR buffer[256 / sizeof(WCHAR)];
2109 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2110 size_t msglen;
2111
2112 OutputDebugStringW(L"Fatal Python error: ");
2113
2114 msglen = strlen(msg);
2115 while (msglen) {
2116 size_t i;
2117
2118 if (buflen > msglen) {
2119 buflen = msglen;
2120 }
2121
2122 /* Convert the message to wchar_t. This uses a simple one-to-one
2123 conversion, assuming that the this error message actually uses
2124 ASCII only. If this ceases to be true, we will have to convert. */
2125 for (i=0; i < buflen; ++i) {
2126 buffer[i] = msg[i];
2127 }
2128 buffer[i] = L'\0';
2129 OutputDebugStringW(buffer);
2130
2131 msg += buflen;
2132 msglen -= buflen;
2133 }
2134 OutputDebugStringW(L"\n");
2135}
2136#endif
2137
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002138
2139static void
2140fatal_error_dump_runtime(FILE *stream, _PyRuntimeState *runtime)
2141{
2142 fprintf(stream, "Python runtime state: ");
2143 if (runtime->finalizing) {
2144 fprintf(stream, "finalizing (tstate=%p)", runtime->finalizing);
2145 }
2146 else if (runtime->initialized) {
2147 fprintf(stream, "initialized");
2148 }
2149 else if (runtime->core_initialized) {
2150 fprintf(stream, "core initialized");
2151 }
2152 else if (runtime->preinitialized) {
2153 fprintf(stream, "preinitialized");
2154 }
2155 else if (runtime->preinitializing) {
2156 fprintf(stream, "preinitializing");
2157 }
2158 else {
2159 fprintf(stream, "unknown");
2160 }
2161 fprintf(stream, "\n");
2162 fflush(stream);
2163}
2164
2165
Benjamin Petersoncef88b92017-11-25 13:02:55 -08002166static void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002167fatal_error(const char *prefix, const char *msg, int status)
Nick Coghland6009512014-11-20 21:39:37 +10002168{
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002169 FILE *stream = stderr;
2170 const int fd = fileno(stream);
Victor Stinner53345a42015-03-25 01:55:14 +01002171 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002172
2173 if (reentrant) {
2174 /* Py_FatalError() caused a second fatal error.
2175 Example: flush_std_files() raises a recursion error. */
2176 goto exit;
2177 }
2178 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002179
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002180 fprintf(stream, "Fatal Python error: ");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002181 if (prefix) {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002182 fputs(prefix, stream);
2183 fputs(": ", stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002184 }
2185 if (msg) {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002186 fputs(msg, stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002187 }
2188 else {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002189 fprintf(stream, "<message not set>");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002190 }
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002191 fputs("\n", stream);
2192 fflush(stream); /* it helps in Windows debug build */
2193
2194 _PyRuntimeState *runtime = &_PyRuntime;
2195 fatal_error_dump_runtime(stream, runtime);
2196
2197 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
2198 PyInterpreterState *interp = NULL;
2199 if (tstate != NULL) {
2200 interp = tstate->interp;
2201 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002202
Victor Stinner3a228ab2018-11-01 00:26:41 +01002203 /* Check if the current thread has a Python thread state
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002204 and holds the GIL.
Victor Stinner3a228ab2018-11-01 00:26:41 +01002205
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002206 tss_tstate is NULL if Py_FatalError() is called from a C thread which
2207 has no Python thread state.
2208
2209 tss_tstate != tstate if the current Python thread does not hold the GIL.
2210 */
2211 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2212 int has_tstate_and_gil = (tss_tstate != NULL && tss_tstate == tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002213 if (has_tstate_and_gil) {
2214 /* If an exception is set, print the exception with its traceback */
2215 if (!_Py_FatalError_PrintExc(fd)) {
2216 /* No exception is set, or an exception is set without traceback */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002217 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002218 }
2219 }
2220 else {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002221 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002222 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002223
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002224 /* The main purpose of faulthandler is to display the traceback.
2225 This function already did its best to display a traceback.
2226 Disable faulthandler to prevent writing a second traceback
2227 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002228 _PyFaulthandler_Fini();
2229
Victor Stinner791da1c2016-03-14 16:53:12 +01002230 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002231 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002232 /* Flush sys.stdout and sys.stderr */
2233 flush_std_files();
2234 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002235
Nick Coghland6009512014-11-20 21:39:37 +10002236#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002237 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002238#endif /* MS_WINDOWS */
2239
2240exit:
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002241 if (status < 0) {
Victor Stinner53345a42015-03-25 01:55:14 +01002242#if defined(MS_WINDOWS) && defined(_DEBUG)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002243 DebugBreak();
Nick Coghland6009512014-11-20 21:39:37 +10002244#endif
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002245 abort();
2246 }
2247 else {
2248 exit(status);
2249 }
2250}
2251
Victor Stinner19760862017-12-20 01:41:59 +01002252void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002253Py_FatalError(const char *msg)
2254{
2255 fatal_error(NULL, msg, -1);
2256}
2257
Victor Stinner19760862017-12-20 01:41:59 +01002258void _Py_NO_RETURN
Victor Stinner331a6a52019-05-27 16:39:22 +02002259Py_ExitStatusException(PyStatus status)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002260{
Victor Stinner331a6a52019-05-27 16:39:22 +02002261 if (_PyStatus_IS_EXIT(status)) {
2262 exit(status.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002263 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002264 else if (_PyStatus_IS_ERROR(status)) {
2265 fatal_error(status.func, status.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002266 }
2267 else {
Victor Stinner331a6a52019-05-27 16:39:22 +02002268 Py_FatalError("Py_ExitStatusException() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002269 }
Nick Coghland6009512014-11-20 21:39:37 +10002270}
2271
2272/* Clean up and exit */
2273
Victor Stinnerd7292b52016-06-17 12:29:00 +02002274# include "pythread.h"
Nick Coghland6009512014-11-20 21:39:37 +10002275
Nick Coghland6009512014-11-20 21:39:37 +10002276/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002277void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002278{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002279 PyInterpreterState *is = _PyInterpreterState_GET_UNSAFE();
Marcel Plch776407f2017-12-20 11:17:58 +01002280
Antoine Pitroufc5db952017-12-13 02:29:07 +01002281 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002282 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2283
2284 is->pyexitfunc = func;
2285 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002286}
2287
2288static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002289call_py_exitfuncs(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002290{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002291 PyInterpreterState *interp = tstate->interp;
2292 if (interp->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002293 return;
2294
Victor Stinnerb45d2592019-06-20 00:05:23 +02002295 (*interp->pyexitfunc)(interp->pyexitmodule);
2296 _PyErr_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10002297}
2298
2299/* Wait until threading._shutdown completes, provided
2300 the threading module was imported in the first place.
2301 The shutdown routine will wait until all non-daemon
2302 "threading" threads have completed. */
2303static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002304wait_for_thread_shutdown(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002305{
Nick Coghland6009512014-11-20 21:39:37 +10002306 _Py_IDENTIFIER(_shutdown);
2307 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002308 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002309 if (threading == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +02002310 if (_PyErr_Occurred(tstate)) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002311 PyErr_WriteUnraisable(NULL);
2312 }
2313 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002314 return;
2315 }
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002316 result = _PyObject_CallMethodIdNoArgs(threading, &PyId__shutdown);
Nick Coghland6009512014-11-20 21:39:37 +10002317 if (result == NULL) {
2318 PyErr_WriteUnraisable(threading);
2319 }
2320 else {
2321 Py_DECREF(result);
2322 }
2323 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002324}
2325
2326#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002327int Py_AtExit(void (*func)(void))
2328{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002329 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002330 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002331 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002332 return 0;
2333}
2334
2335static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002336call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002337{
Victor Stinner8e91c242019-04-24 17:24:01 +02002338 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002339 /* pop last function from the list */
2340 runtime->nexitfuncs--;
2341 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2342 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2343
2344 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002345 }
Nick Coghland6009512014-11-20 21:39:37 +10002346
2347 fflush(stdout);
2348 fflush(stderr);
2349}
2350
Victor Stinnercfc88312018-08-01 16:41:25 +02002351void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002352Py_Exit(int sts)
2353{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002354 if (Py_FinalizeEx() < 0) {
2355 sts = 120;
2356 }
Nick Coghland6009512014-11-20 21:39:37 +10002357
2358 exit(sts);
2359}
2360
Victor Stinner331a6a52019-05-27 16:39:22 +02002361static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02002362init_signals(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002363{
2364#ifdef SIGPIPE
2365 PyOS_setsig(SIGPIPE, SIG_IGN);
2366#endif
2367#ifdef SIGXFZ
2368 PyOS_setsig(SIGXFZ, SIG_IGN);
2369#endif
2370#ifdef SIGXFSZ
2371 PyOS_setsig(SIGXFSZ, SIG_IGN);
2372#endif
2373 PyOS_InitInterrupts(); /* May imply initsignal() */
Victor Stinnerb45d2592019-06-20 00:05:23 +02002374 if (_PyErr_Occurred(tstate)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002375 return _PyStatus_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002376 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002377 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002378}
2379
2380
2381/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2382 *
2383 * All of the code in this function must only use async-signal-safe functions,
2384 * listed at `man 7 signal` or
2385 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2386 */
2387void
2388_Py_RestoreSignals(void)
2389{
2390#ifdef SIGPIPE
2391 PyOS_setsig(SIGPIPE, SIG_DFL);
2392#endif
2393#ifdef SIGXFZ
2394 PyOS_setsig(SIGXFZ, SIG_DFL);
2395#endif
2396#ifdef SIGXFSZ
2397 PyOS_setsig(SIGXFSZ, SIG_DFL);
2398#endif
2399}
2400
2401
2402/*
2403 * The file descriptor fd is considered ``interactive'' if either
2404 * a) isatty(fd) is TRUE, or
2405 * b) the -i flag was given, and the filename associated with
2406 * the descriptor is NULL or "<stdin>" or "???".
2407 */
2408int
2409Py_FdIsInteractive(FILE *fp, const char *filename)
2410{
2411 if (isatty((int)fileno(fp)))
2412 return 1;
2413 if (!Py_InteractiveFlag)
2414 return 0;
2415 return (filename == NULL) ||
2416 (strcmp(filename, "<stdin>") == 0) ||
2417 (strcmp(filename, "???") == 0);
2418}
2419
2420
Nick Coghland6009512014-11-20 21:39:37 +10002421/* Wrappers around sigaction() or signal(). */
2422
2423PyOS_sighandler_t
2424PyOS_getsig(int sig)
2425{
2426#ifdef HAVE_SIGACTION
2427 struct sigaction context;
2428 if (sigaction(sig, NULL, &context) == -1)
2429 return SIG_ERR;
2430 return context.sa_handler;
2431#else
2432 PyOS_sighandler_t handler;
2433/* Special signal handling for the secure CRT in Visual Studio 2005 */
2434#if defined(_MSC_VER) && _MSC_VER >= 1400
2435 switch (sig) {
2436 /* Only these signals are valid */
2437 case SIGINT:
2438 case SIGILL:
2439 case SIGFPE:
2440 case SIGSEGV:
2441 case SIGTERM:
2442 case SIGBREAK:
2443 case SIGABRT:
2444 break;
2445 /* Don't call signal() with other values or it will assert */
2446 default:
2447 return SIG_ERR;
2448 }
2449#endif /* _MSC_VER && _MSC_VER >= 1400 */
2450 handler = signal(sig, SIG_IGN);
2451 if (handler != SIG_ERR)
2452 signal(sig, handler);
2453 return handler;
2454#endif
2455}
2456
2457/*
2458 * All of the code in this function must only use async-signal-safe functions,
2459 * listed at `man 7 signal` or
2460 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2461 */
2462PyOS_sighandler_t
2463PyOS_setsig(int sig, PyOS_sighandler_t handler)
2464{
2465#ifdef HAVE_SIGACTION
2466 /* Some code in Modules/signalmodule.c depends on sigaction() being
2467 * used here if HAVE_SIGACTION is defined. Fix that if this code
2468 * changes to invalidate that assumption.
2469 */
2470 struct sigaction context, ocontext;
2471 context.sa_handler = handler;
2472 sigemptyset(&context.sa_mask);
2473 context.sa_flags = 0;
2474 if (sigaction(sig, &context, &ocontext) == -1)
2475 return SIG_ERR;
2476 return ocontext.sa_handler;
2477#else
2478 PyOS_sighandler_t oldhandler;
2479 oldhandler = signal(sig, handler);
2480#ifdef HAVE_SIGINTERRUPT
2481 siginterrupt(sig, 1);
2482#endif
2483 return oldhandler;
2484#endif
2485}
2486
2487#ifdef __cplusplus
2488}
2489#endif