blob: 4f05dfc349033b870dcee6a02a74013688184195 [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 Stinner630c8df2019-12-17 13:02:18 +0100579 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100580
Victor Stinner630c8df2019-12-17 13:02:18 +0100581
582 if (!_PyLong_Init(tstate)) {
583 return _PyStatus_ERR("can't init longs");
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100584 }
Victor Stinneref5aa9a2019-11-20 00:38:03 +0100585
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100586 if (is_main_interp) {
Victor Stinnere7e699e2019-11-20 12:08:13 +0100587 status = _PyUnicode_Init();
588 if (_PyStatus_EXCEPTION(status)) {
589 return status;
590 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100591 }
592
Victor Stinner331a6a52019-05-27 16:39:22 +0200593 status = _PyExc_Init();
594 if (_PyStatus_EXCEPTION(status)) {
595 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100596 }
597
Victor Stinnere7e699e2019-11-20 12:08:13 +0100598 if (is_main_interp) {
599 if (!_PyFloat_Init()) {
600 return _PyStatus_ERR("can't init float");
601 }
Nick Coghland6009512014-11-20 21:39:37 +1000602
Victor Stinnere7e699e2019-11-20 12:08:13 +0100603 if (_PyStructSequence_Init() < 0) {
604 return _PyStatus_ERR("can't initialize structseq");
605 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100606 }
Victor Stinneref9d9b62019-05-22 11:28:22 +0200607
Victor Stinner331a6a52019-05-27 16:39:22 +0200608 status = _PyErr_Init();
609 if (_PyStatus_EXCEPTION(status)) {
610 return status;
Victor Stinneref9d9b62019-05-22 11:28:22 +0200611 }
612
Victor Stinnere7e699e2019-11-20 12:08:13 +0100613 if (is_main_interp) {
614 if (!_PyContext_Init()) {
615 return _PyStatus_ERR("can't init context");
616 }
Victor Stinneref5aa9a2019-11-20 00:38:03 +0100617 }
618
Victor Stinner331a6a52019-05-27 16:39:22 +0200619 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100620}
621
622
Victor Stinner331a6a52019-05-27 16:39:22 +0200623static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200624pycore_init_builtins(PyThreadState *tstate)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100625{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100626 assert(!_PyErr_Occurred(tstate));
627
Victor Stinnerb45d2592019-06-20 00:05:23 +0200628 PyObject *bimod = _PyBuiltin_Init(tstate);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100629 if (bimod == NULL) {
Victor Stinner2582d462019-11-22 19:24:49 +0100630 goto error;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100631 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100632
Victor Stinner2582d462019-11-22 19:24:49 +0100633 PyInterpreterState *interp = tstate->interp;
634 if (_PyImport_FixupBuiltin(bimod, "builtins", interp->modules) < 0) {
635 goto error;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100636 }
Victor Stinner2582d462019-11-22 19:24:49 +0100637
638 PyObject *builtins_dict = PyModule_GetDict(bimod);
639 if (builtins_dict == NULL) {
640 goto error;
641 }
642 Py_INCREF(builtins_dict);
643 interp->builtins = builtins_dict;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100644
Victor Stinner331a6a52019-05-27 16:39:22 +0200645 PyStatus status = _PyBuiltins_AddExceptions(bimod);
646 if (_PyStatus_EXCEPTION(status)) {
647 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100648 }
Victor Stinner2582d462019-11-22 19:24:49 +0100649
650 interp->builtins_copy = PyDict_Copy(interp->builtins);
651 if (interp->builtins_copy == NULL) {
652 goto error;
653 }
Pablo Galindob96c6b02019-12-04 11:19:59 +0000654 Py_DECREF(bimod);
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100655
656 assert(!_PyErr_Occurred(tstate));
657
Victor Stinner331a6a52019-05-27 16:39:22 +0200658 return _PyStatus_OK();
Victor Stinner2582d462019-11-22 19:24:49 +0100659
660error:
Pablo Galindob96c6b02019-12-04 11:19:59 +0000661 Py_XDECREF(bimod);
Victor Stinner2582d462019-11-22 19:24:49 +0100662 return _PyStatus_ERR("can't initialize builtins module");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100663}
664
665
Victor Stinner331a6a52019-05-27 16:39:22 +0200666static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200667pycore_init_import_warnings(PyThreadState *tstate, PyObject *sysmod)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100668{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100669 assert(!_PyErr_Occurred(tstate));
Victor Stinnerb45d2592019-06-20 00:05:23 +0200670
Victor Stinner2582d462019-11-22 19:24:49 +0100671 PyStatus status = _PyImportHooks_Init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200672 if (_PyStatus_EXCEPTION(status)) {
673 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800674 }
Nick Coghland6009512014-11-20 21:39:37 +1000675
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100676 const PyConfig *config = &tstate->interp->config;
Victor Stinner2ec1a1b2019-11-22 21:54:33 +0100677 if (_Py_IsMainInterpreter(tstate)) {
678 /* Initialize _warnings. */
679 if (_PyWarnings_Init() == NULL) {
680 return _PyStatus_ERR("can't initialize warnings");
681 }
Nick Coghland6009512014-11-20 21:39:37 +1000682
Victor Stinner2ec1a1b2019-11-22 21:54:33 +0100683 if (config->_install_importlib) {
684 status = _PyConfig_WritePathConfig(config);
685 if (_PyStatus_EXCEPTION(status)) {
686 return status;
687 }
Victor Stinnerb1147e42018-07-21 02:06:16 +0200688 }
689 }
690
Eric Snow1abcf672017-05-23 21:46:51 -0700691 /* This call sets up builtin and frozen import support */
Victor Stinnerb45d2592019-06-20 00:05:23 +0200692 if (config->_install_importlib) {
693 status = init_importlib(tstate, sysmod);
Victor Stinner331a6a52019-05-27 16:39:22 +0200694 if (_PyStatus_EXCEPTION(status)) {
695 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800696 }
Eric Snow1abcf672017-05-23 21:46:51 -0700697 }
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100698
699 assert(!_PyErr_Occurred(tstate));
700
Victor Stinner331a6a52019-05-27 16:39:22 +0200701 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100702}
703
704
Victor Stinner331a6a52019-05-27 16:39:22 +0200705static PyStatus
Victor Stinnerd863ade2019-12-06 03:37:07 +0100706pycore_interp_init(PyThreadState *tstate)
707{
708 PyStatus status;
Victor Stinner080ee5a2019-12-08 21:55:58 +0100709 PyObject *sysmod = NULL;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100710
711 status = pycore_init_types(tstate);
712 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100713 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100714 }
715
Victor Stinnerd863ade2019-12-06 03:37:07 +0100716 status = _PySys_Create(tstate, &sysmod);
717 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100718 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100719 }
720
721 status = pycore_init_builtins(tstate);
722 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner080ee5a2019-12-08 21:55:58 +0100723 goto done;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100724 }
725
Victor Stinner080ee5a2019-12-08 21:55:58 +0100726 status = pycore_init_import_warnings(tstate, sysmod);
727
728done:
729 /* sys.modules['sys'] contains a strong reference to the module */
730 Py_XDECREF(sysmod);
731 return status;
Victor Stinnerd863ade2019-12-06 03:37:07 +0100732}
733
734
735static PyStatus
Victor Stinner331a6a52019-05-27 16:39:22 +0200736pyinit_config(_PyRuntimeState *runtime,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200737 PyThreadState **tstate_p,
Victor Stinner331a6a52019-05-27 16:39:22 +0200738 const PyConfig *config)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100739{
Victor Stinner331a6a52019-05-27 16:39:22 +0200740 _PyConfig_Write(config, runtime);
Victor Stinner20004952019-03-26 02:31:11 +0100741
Victor Stinner331a6a52019-05-27 16:39:22 +0200742 PyStatus status = pycore_init_runtime(runtime, config);
743 if (_PyStatus_EXCEPTION(status)) {
744 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100745 }
746
Victor Stinnerb45d2592019-06-20 00:05:23 +0200747 PyThreadState *tstate;
748 status = pycore_create_interpreter(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200749 if (_PyStatus_EXCEPTION(status)) {
750 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100751 }
Victor Stinnerb45d2592019-06-20 00:05:23 +0200752 config = &tstate->interp->config;
753 *tstate_p = tstate;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100754
Victor Stinnerd863ade2019-12-06 03:37:07 +0100755 status = pycore_interp_init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200756 if (_PyStatus_EXCEPTION(status)) {
757 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100758 }
Eric Snow1abcf672017-05-23 21:46:51 -0700759
760 /* Only when we get here is the runtime core fully initialized */
Victor Stinner43125222019-04-24 18:23:53 +0200761 runtime->core_initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200762 return _PyStatus_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700763}
764
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100765
Victor Stinner331a6a52019-05-27 16:39:22 +0200766PyStatus
767_Py_PreInitializeFromPyArgv(const PyPreConfig *src_config, const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100768{
Victor Stinner331a6a52019-05-27 16:39:22 +0200769 PyStatus status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100770
Victor Stinner6d1c4672019-05-20 11:02:00 +0200771 if (src_config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200772 return _PyStatus_ERR("preinitialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +0200773 }
774
Victor Stinner331a6a52019-05-27 16:39:22 +0200775 status = _PyRuntime_Initialize();
776 if (_PyStatus_EXCEPTION(status)) {
777 return status;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100778 }
Victor Stinner43125222019-04-24 18:23:53 +0200779 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100780
Victor Stinnerd3b90412019-09-17 23:59:51 +0200781 if (runtime->preinitialized) {
Victor Stinnerf72346c2019-03-25 17:54:58 +0100782 /* If it's already configured: ignored the new configuration */
Victor Stinner331a6a52019-05-27 16:39:22 +0200783 return _PyStatus_OK();
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100784 }
785
Victor Stinnerd3b90412019-09-17 23:59:51 +0200786 /* Note: preinitialized remains 1 on error, it is only set to 0
787 at exit on success. */
788 runtime->preinitializing = 1;
789
Victor Stinner331a6a52019-05-27 16:39:22 +0200790 PyPreConfig config;
Victor Stinner441b10c2019-09-28 04:28:35 +0200791
792 status = _PyPreConfig_InitFromPreConfig(&config, src_config);
793 if (_PyStatus_EXCEPTION(status)) {
794 return status;
795 }
Victor Stinnerf72346c2019-03-25 17:54:58 +0100796
Victor Stinner331a6a52019-05-27 16:39:22 +0200797 status = _PyPreConfig_Read(&config, args);
798 if (_PyStatus_EXCEPTION(status)) {
799 return status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100800 }
801
Victor Stinner331a6a52019-05-27 16:39:22 +0200802 status = _PyPreConfig_Write(&config);
803 if (_PyStatus_EXCEPTION(status)) {
804 return status;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100805 }
806
Victor Stinnerd3b90412019-09-17 23:59:51 +0200807 runtime->preinitializing = 0;
808 runtime->preinitialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200809 return _PyStatus_OK();
Victor Stinnerf72346c2019-03-25 17:54:58 +0100810}
811
Victor Stinner70005ac2019-05-02 15:25:34 -0400812
Victor Stinner331a6a52019-05-27 16:39:22 +0200813PyStatus
814Py_PreInitializeFromBytesArgs(const PyPreConfig *src_config, Py_ssize_t argc, char **argv)
Victor Stinnerf72346c2019-03-25 17:54:58 +0100815{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100816 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400817 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100818}
819
820
Victor Stinner331a6a52019-05-27 16:39:22 +0200821PyStatus
822Py_PreInitializeFromArgs(const PyPreConfig *src_config, Py_ssize_t argc, wchar_t **argv)
Victor Stinner20004952019-03-26 02:31:11 +0100823{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100824 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400825 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinner20004952019-03-26 02:31:11 +0100826}
827
828
Victor Stinner331a6a52019-05-27 16:39:22 +0200829PyStatus
830Py_PreInitialize(const PyPreConfig *src_config)
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100831{
Victor Stinner70005ac2019-05-02 15:25:34 -0400832 return _Py_PreInitializeFromPyArgv(src_config, NULL);
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100833}
834
835
Victor Stinner331a6a52019-05-27 16:39:22 +0200836PyStatus
837_Py_PreInitializeFromConfig(const PyConfig *config,
838 const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100839{
Victor Stinner331a6a52019-05-27 16:39:22 +0200840 assert(config != NULL);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200841
Victor Stinner331a6a52019-05-27 16:39:22 +0200842 PyStatus status = _PyRuntime_Initialize();
843 if (_PyStatus_EXCEPTION(status)) {
844 return status;
Victor Stinner6d1c4672019-05-20 11:02:00 +0200845 }
846 _PyRuntimeState *runtime = &_PyRuntime;
847
Victor Stinnerd3b90412019-09-17 23:59:51 +0200848 if (runtime->preinitialized) {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200849 /* Already initialized: do nothing */
Victor Stinner331a6a52019-05-27 16:39:22 +0200850 return _PyStatus_OK();
Victor Stinner70005ac2019-05-02 15:25:34 -0400851 }
Victor Stinnercab5d072019-05-17 19:01:14 +0200852
Victor Stinner331a6a52019-05-27 16:39:22 +0200853 PyPreConfig preconfig;
Victor Stinner441b10c2019-09-28 04:28:35 +0200854
Victor Stinner3c30a762019-10-01 10:56:37 +0200855 _PyPreConfig_InitFromConfig(&preconfig, config);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200856
Victor Stinner331a6a52019-05-27 16:39:22 +0200857 if (!config->parse_argv) {
858 return Py_PreInitialize(&preconfig);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200859 }
860 else if (args == NULL) {
Victor Stinnercab5d072019-05-17 19:01:14 +0200861 _PyArgv config_args = {
862 .use_bytes_argv = 0,
Victor Stinner331a6a52019-05-27 16:39:22 +0200863 .argc = config->argv.length,
864 .wchar_argv = config->argv.items};
Victor Stinner6d1c4672019-05-20 11:02:00 +0200865 return _Py_PreInitializeFromPyArgv(&preconfig, &config_args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200866 }
867 else {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200868 return _Py_PreInitializeFromPyArgv(&preconfig, args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200869 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100870}
871
872
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100873/* Begin interpreter initialization
874 *
875 * On return, the first thread and interpreter state have been created,
876 * but the compiler, signal handling, multithreading and
877 * multiple interpreter support, and codec infrastructure are not yet
878 * available.
879 *
880 * The import system will support builtin and frozen modules only.
881 * The only supported io is writing to sys.stderr
882 *
883 * If any operation invoked by this function fails, a fatal error is
884 * issued and the function does not return.
885 *
886 * Any code invoked from this function should *not* assume it has access
887 * to the Python C API (unless the API is explicitly listed as being
888 * safe to call without calling Py_Initialize first)
889 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200890static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200891pyinit_core(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200892 const PyConfig *src_config,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200893 PyThreadState **tstate_p)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200894{
Victor Stinner331a6a52019-05-27 16:39:22 +0200895 PyStatus status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200896
Victor Stinner331a6a52019-05-27 16:39:22 +0200897 status = _Py_PreInitializeFromConfig(src_config, NULL);
898 if (_PyStatus_EXCEPTION(status)) {
899 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200900 }
901
Victor Stinner331a6a52019-05-27 16:39:22 +0200902 PyConfig config;
Victor Stinner8462a492019-10-01 12:06:16 +0200903 _PyConfig_InitCompatConfig(&config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200904
Victor Stinner331a6a52019-05-27 16:39:22 +0200905 status = _PyConfig_Copy(&config, src_config);
906 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200907 goto done;
908 }
909
Victor Stinner331a6a52019-05-27 16:39:22 +0200910 status = PyConfig_Read(&config);
911 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200912 goto done;
913 }
914
915 if (!runtime->core_initialized) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200916 status = pyinit_config(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200917 }
918 else {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200919 status = pyinit_core_reconfigure(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200920 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200921 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200922 goto done;
923 }
924
925done:
Victor Stinner331a6a52019-05-27 16:39:22 +0200926 PyConfig_Clear(&config);
927 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200928}
929
Victor Stinner5ac27a52019-03-27 13:40:14 +0100930
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200931/* Py_Initialize() has already been called: update the main interpreter
932 configuration. Example of bpo-34008: Py_Main() called after
933 Py_Initialize(). */
Victor Stinner331a6a52019-05-27 16:39:22 +0200934static PyStatus
Victor Stinnerb0051362019-11-22 17:52:42 +0100935_Py_ReconfigureMainInterpreter(PyThreadState *tstate)
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200936{
Victor Stinnerb0051362019-11-22 17:52:42 +0100937 PyConfig *config = &tstate->interp->config;
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100938
Victor Stinner331a6a52019-05-27 16:39:22 +0200939 PyObject *argv = _PyWideStringList_AsList(&config->argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100940 if (argv == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200941 return _PyStatus_NO_MEMORY(); \
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100942 }
943
Victor Stinnerb0051362019-11-22 17:52:42 +0100944 int res = PyDict_SetItemString(tstate->interp->sysdict, "argv", argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100945 Py_DECREF(argv);
946 if (res < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200947 return _PyStatus_ERR("fail to set sys.argv");
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200948 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200949 return _PyStatus_OK();
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200950}
951
Victor Stinnerb0051362019-11-22 17:52:42 +0100952
953static PyStatus
954init_interp_main(PyThreadState *tstate)
955{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100956 assert(!_PyErr_Occurred(tstate));
957
Victor Stinnerb0051362019-11-22 17:52:42 +0100958 PyStatus status;
959 int is_main_interp = _Py_IsMainInterpreter(tstate);
960 PyInterpreterState *interp = tstate->interp;
961 PyConfig *config = &interp->config;
962
963 if (!config->_install_importlib) {
964 /* Special mode for freeze_importlib: run with no import system
965 *
966 * This means anything which needs support from extension modules
967 * or pure Python code in the standard library won't work.
968 */
969 if (is_main_interp) {
970 interp->runtime->initialized = 1;
971 }
972 return _PyStatus_OK();
973 }
974
975 if (is_main_interp) {
976 if (_PyTime_Init() < 0) {
977 return _PyStatus_ERR("can't initialize time");
978 }
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100979 }
Victor Stinnerb0051362019-11-22 17:52:42 +0100980
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100981 if (_PySys_InitMain(tstate) < 0) {
982 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerb0051362019-11-22 17:52:42 +0100983 }
984
985 status = init_importlib_external(tstate);
986 if (_PyStatus_EXCEPTION(status)) {
987 return status;
988 }
989
990 if (is_main_interp) {
991 /* initialize the faulthandler module */
992 status = _PyFaulthandler_Init(config->faulthandler);
993 if (_PyStatus_EXCEPTION(status)) {
994 return status;
995 }
996 }
997
998 status = _PyUnicode_InitEncodings(tstate);
999 if (_PyStatus_EXCEPTION(status)) {
1000 return status;
1001 }
1002
1003 if (is_main_interp) {
1004 if (config->install_signal_handlers) {
1005 status = init_signals(tstate);
1006 if (_PyStatus_EXCEPTION(status)) {
1007 return status;
1008 }
1009 }
1010
1011 if (_PyTraceMalloc_Init(config->tracemalloc) < 0) {
1012 return _PyStatus_ERR("can't initialize tracemalloc");
1013 }
1014 }
1015
1016 status = init_sys_streams(tstate);
1017 if (_PyStatus_EXCEPTION(status)) {
1018 return status;
1019 }
1020
1021 status = init_set_builtins_open(tstate);
1022 if (_PyStatus_EXCEPTION(status)) {
1023 return status;
1024 }
1025
1026 status = add_main_module(interp);
1027 if (_PyStatus_EXCEPTION(status)) {
1028 return status;
1029 }
1030
1031 if (is_main_interp) {
1032 /* Initialize warnings. */
1033 PyObject *warnoptions = PySys_GetObject("warnoptions");
1034 if (warnoptions != NULL && PyList_Size(warnoptions) > 0)
1035 {
1036 PyObject *warnings_module = PyImport_ImportModule("warnings");
1037 if (warnings_module == NULL) {
1038 fprintf(stderr, "'import warnings' failed; traceback:\n");
1039 _PyErr_Print(tstate);
1040 }
1041 Py_XDECREF(warnings_module);
1042 }
1043
1044 interp->runtime->initialized = 1;
1045 }
1046
1047 if (config->site_import) {
1048 status = init_import_site();
1049 if (_PyStatus_EXCEPTION(status)) {
1050 return status;
1051 }
1052 }
1053
1054 if (is_main_interp) {
1055#ifndef MS_WINDOWS
1056 emit_stderr_warning_for_legacy_locale(interp->runtime);
1057#endif
1058 }
1059
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001060 assert(!_PyErr_Occurred(tstate));
1061
Victor Stinnerb0051362019-11-22 17:52:42 +01001062 return _PyStatus_OK();
1063}
1064
1065
Eric Snowc7ec9982017-05-23 23:00:52 -07001066/* Update interpreter state based on supplied configuration settings
1067 *
1068 * After calling this function, most of the restrictions on the interpreter
1069 * are lifted. The only remaining incomplete settings are those related
1070 * to the main module (sys.argv[0], __main__ metadata)
1071 *
1072 * Calling this when the interpreter is not initializing, is already
1073 * initialized or without a valid current thread state is a fatal error.
1074 * Other errors should be reported as normal Python exceptions with a
1075 * non-zero return code.
1076 */
Victor Stinner331a6a52019-05-27 16:39:22 +02001077static PyStatus
Victor Stinner01b1cc12019-11-20 02:27:56 +01001078pyinit_main(PyThreadState *tstate)
Eric Snow1abcf672017-05-23 21:46:51 -07001079{
Victor Stinnerb0051362019-11-22 17:52:42 +01001080 PyInterpreterState *interp = tstate->interp;
1081 if (!interp->runtime->core_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001082 return _PyStatus_ERR("runtime core not initialized");
Eric Snowc7ec9982017-05-23 23:00:52 -07001083 }
Eric Snowc7ec9982017-05-23 23:00:52 -07001084
Victor Stinnerb0051362019-11-22 17:52:42 +01001085 if (interp->runtime->initialized) {
1086 return _Py_ReconfigureMainInterpreter(tstate);
Victor Stinnerfb47bca2018-07-20 17:34:23 +02001087 }
1088
Victor Stinnerb0051362019-11-22 17:52:42 +01001089 PyStatus status = init_interp_main(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001090 if (_PyStatus_EXCEPTION(status)) {
1091 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001092 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001093 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001094}
1095
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001096
Victor Stinner331a6a52019-05-27 16:39:22 +02001097PyStatus
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001098_Py_InitializeMain(void)
1099{
Victor Stinner331a6a52019-05-27 16:39:22 +02001100 PyStatus status = _PyRuntime_Initialize();
1101 if (_PyStatus_EXCEPTION(status)) {
1102 return status;
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001103 }
1104 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinnerb45d2592019-06-20 00:05:23 +02001105 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
Victor Stinner01b1cc12019-11-20 02:27:56 +01001106 return pyinit_main(tstate);
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001107}
1108
1109
Victor Stinner331a6a52019-05-27 16:39:22 +02001110PyStatus
1111Py_InitializeFromConfig(const PyConfig *config)
Eric Snow1abcf672017-05-23 21:46:51 -07001112{
Victor Stinner6d1c4672019-05-20 11:02:00 +02001113 if (config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001114 return _PyStatus_ERR("initialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +02001115 }
1116
Victor Stinner331a6a52019-05-27 16:39:22 +02001117 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001118
Victor Stinner331a6a52019-05-27 16:39:22 +02001119 status = _PyRuntime_Initialize();
1120 if (_PyStatus_EXCEPTION(status)) {
1121 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001122 }
1123 _PyRuntimeState *runtime = &_PyRuntime;
1124
Victor Stinnerb45d2592019-06-20 00:05:23 +02001125 PyThreadState *tstate = NULL;
1126 status = pyinit_core(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001127 if (_PyStatus_EXCEPTION(status)) {
1128 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001129 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02001130 config = &tstate->interp->config;
Victor Stinnerbc8ac6b2017-11-30 18:03:55 +01001131
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001132 if (config->_init_main) {
Victor Stinner01b1cc12019-11-20 02:27:56 +01001133 status = pyinit_main(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001134 if (_PyStatus_EXCEPTION(status)) {
1135 return status;
Victor Stinner484f20d2019-03-27 02:04:16 +01001136 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001137 }
Victor Stinner484f20d2019-03-27 02:04:16 +01001138
Victor Stinner331a6a52019-05-27 16:39:22 +02001139 return _PyStatus_OK();
Victor Stinner5ac27a52019-03-27 13:40:14 +01001140}
1141
1142
Eric Snow1abcf672017-05-23 21:46:51 -07001143void
Nick Coghland6009512014-11-20 21:39:37 +10001144Py_InitializeEx(int install_sigs)
1145{
Victor Stinner331a6a52019-05-27 16:39:22 +02001146 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001147
Victor Stinner331a6a52019-05-27 16:39:22 +02001148 status = _PyRuntime_Initialize();
1149 if (_PyStatus_EXCEPTION(status)) {
1150 Py_ExitStatusException(status);
Victor Stinner43125222019-04-24 18:23:53 +02001151 }
1152 _PyRuntimeState *runtime = &_PyRuntime;
1153
1154 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001155 /* bpo-33932: Calling Py_Initialize() twice does nothing. */
1156 return;
1157 }
1158
Victor Stinner331a6a52019-05-27 16:39:22 +02001159 PyConfig config;
Victor Stinner8462a492019-10-01 12:06:16 +02001160 _PyConfig_InitCompatConfig(&config);
Victor Stinner441b10c2019-09-28 04:28:35 +02001161
Victor Stinner1dc6e392018-07-25 02:49:17 +02001162 config.install_signal_handlers = install_sigs;
1163
Victor Stinner331a6a52019-05-27 16:39:22 +02001164 status = Py_InitializeFromConfig(&config);
1165 if (_PyStatus_EXCEPTION(status)) {
1166 Py_ExitStatusException(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001167 }
Nick Coghland6009512014-11-20 21:39:37 +10001168}
1169
1170void
1171Py_Initialize(void)
1172{
1173 Py_InitializeEx(1);
1174}
1175
1176
1177#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001178extern void _Py_dump_counts(FILE*);
Nick Coghland6009512014-11-20 21:39:37 +10001179#endif
1180
1181/* Flush stdout and stderr */
1182
1183static int
1184file_is_closed(PyObject *fobj)
1185{
1186 int r;
1187 PyObject *tmp = PyObject_GetAttrString(fobj, "closed");
1188 if (tmp == NULL) {
1189 PyErr_Clear();
1190 return 0;
1191 }
1192 r = PyObject_IsTrue(tmp);
1193 Py_DECREF(tmp);
1194 if (r < 0)
1195 PyErr_Clear();
1196 return r > 0;
1197}
1198
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001199static int
Nick Coghland6009512014-11-20 21:39:37 +10001200flush_std_files(void)
1201{
1202 PyObject *fout = _PySys_GetObjectId(&PyId_stdout);
1203 PyObject *ferr = _PySys_GetObjectId(&PyId_stderr);
1204 PyObject *tmp;
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001205 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001206
1207 if (fout != NULL && fout != Py_None && !file_is_closed(fout)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001208 tmp = _PyObject_CallMethodIdNoArgs(fout, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001209 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001210 PyErr_WriteUnraisable(fout);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001211 status = -1;
1212 }
Nick Coghland6009512014-11-20 21:39:37 +10001213 else
1214 Py_DECREF(tmp);
1215 }
1216
1217 if (ferr != NULL && ferr != Py_None && !file_is_closed(ferr)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001218 tmp = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001219 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001220 PyErr_Clear();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001221 status = -1;
1222 }
Nick Coghland6009512014-11-20 21:39:37 +10001223 else
1224 Py_DECREF(tmp);
1225 }
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001226
1227 return status;
Nick Coghland6009512014-11-20 21:39:37 +10001228}
1229
1230/* Undo the effect of Py_Initialize().
1231
1232 Beware: if multiple interpreter and/or thread states exist, these
1233 are not wiped out; only the current thread and interpreter state
1234 are deleted. But since everything else is deleted, those other
1235 interpreter and thread states should no longer be used.
1236
1237 (XXX We should do better, e.g. wipe out all interpreters and
1238 threads.)
1239
1240 Locking: as above.
1241
1242*/
1243
Victor Stinner7eee5be2019-11-20 10:38:34 +01001244
1245static void
1246finalize_interp_types(PyThreadState *tstate, int is_main_interp)
1247{
1248 if (is_main_interp) {
1249 /* Sundry finalizers */
Victor Stinner7eee5be2019-11-20 10:38:34 +01001250 _PyFrame_Fini();
Victor Stinner7eee5be2019-11-20 10:38:34 +01001251 _PyTuple_Fini();
1252 _PyList_Fini();
1253 _PySet_Fini();
1254 _PyBytes_Fini();
Victor Stinner630c8df2019-12-17 13:02:18 +01001255 }
1256
1257 _PyLong_Fini(tstate);
1258
1259 if (is_main_interp) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001260 _PyFloat_Fini();
1261 _PyDict_Fini();
1262 _PySlice_Fini();
1263 }
1264
1265 _PyWarnings_Fini(tstate->interp);
1266
1267 if (is_main_interp) {
1268 _Py_HashRandomization_Fini();
1269 _PyArg_Fini();
1270 _PyAsyncGen_Fini();
1271 _PyContext_Fini();
Victor Stinner3d483342019-11-22 12:27:50 +01001272 }
Victor Stinner7eee5be2019-11-20 10:38:34 +01001273
Victor Stinner3d483342019-11-22 12:27:50 +01001274 /* Cleanup Unicode implementation */
1275 _PyUnicode_Fini(tstate);
1276
1277 if (is_main_interp) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001278 _Py_ClearFileSystemEncoding();
1279 }
1280}
1281
1282
1283static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001284finalize_interp_clear(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001285{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001286 int is_main_interp = _Py_IsMainInterpreter(tstate);
1287
Victor Stinner7eee5be2019-11-20 10:38:34 +01001288 /* Clear interpreter state and all thread states */
1289 PyInterpreterState_Clear(tstate->interp);
1290
Pablo Galindoac0e1c22019-12-04 11:51:03 +00001291 /* Trigger a GC collection on subinterpreters*/
1292 if (!is_main_interp) {
1293 _PyGC_CollectNoFail();
1294 }
1295
Victor Stinner7eee5be2019-11-20 10:38:34 +01001296 finalize_interp_types(tstate, is_main_interp);
1297
1298 if (is_main_interp) {
1299 /* XXX Still allocated:
1300 - various static ad-hoc pointers to interned strings
1301 - int and float free list blocks
1302 - whatever various modules and libraries allocate
1303 */
1304
1305 PyGrammar_RemoveAccelerators(&_PyParser_Grammar);
1306
1307 _PyExc_Fini();
Victor Stinner7eee5be2019-11-20 10:38:34 +01001308 }
Victor Stinner72474072019-11-20 12:25:50 +01001309
1310 _PyGC_Fini(tstate);
Victor Stinner7eee5be2019-11-20 10:38:34 +01001311}
1312
1313
1314static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001315finalize_interp_delete(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001316{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001317 if (_Py_IsMainInterpreter(tstate)) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001318 /* Cleanup auto-thread-state */
1319 _PyGILState_Fini(tstate);
1320 }
1321
Victor Stinner7eee5be2019-11-20 10:38:34 +01001322 PyInterpreterState_Delete(tstate->interp);
1323}
1324
1325
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001326int
1327Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001328{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001329 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001330
Victor Stinner8e91c242019-04-24 17:24:01 +02001331 _PyRuntimeState *runtime = &_PyRuntime;
1332 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001333 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001334 }
Nick Coghland6009512014-11-20 21:39:37 +10001335
Victor Stinnere225beb2019-06-03 18:14:24 +02001336 /* Get current thread state and interpreter pointer */
1337 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
1338 PyInterpreterState *interp = tstate->interp;
Victor Stinner8e91c242019-04-24 17:24:01 +02001339
Victor Stinnerb45d2592019-06-20 00:05:23 +02001340 // Wrap up existing "threading"-module-created, non-daemon threads.
1341 wait_for_thread_shutdown(tstate);
1342
1343 // Make any remaining pending calls.
1344 _Py_FinishPendingCalls(runtime);
1345
Nick Coghland6009512014-11-20 21:39:37 +10001346 /* The interpreter is still entirely intact at this point, and the
1347 * exit funcs may be relying on that. In particular, if some thread
1348 * or exit func is still waiting to do an import, the import machinery
1349 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001350 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001351 * Note that Threading.py uses an exit func to do a join on all the
1352 * threads created thru it, so this also protects pending imports in
1353 * the threads created via Threading.
1354 */
Nick Coghland6009512014-11-20 21:39:37 +10001355
Victor Stinnerb45d2592019-06-20 00:05:23 +02001356 call_py_exitfuncs(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001357
Victor Stinnerda273412017-12-15 01:46:02 +01001358 /* Copy the core config, PyInterpreterState_Delete() free
1359 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001360#ifdef Py_REF_DEBUG
Victor Stinner331a6a52019-05-27 16:39:22 +02001361 int show_ref_count = interp->config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001362#endif
1363#ifdef Py_TRACE_REFS
Victor Stinner331a6a52019-05-27 16:39:22 +02001364 int dump_refs = interp->config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001365#endif
1366#ifdef WITH_PYMALLOC
Victor Stinner331a6a52019-05-27 16:39:22 +02001367 int malloc_stats = interp->config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001368#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001369
Nick Coghland6009512014-11-20 21:39:37 +10001370 /* Remaining threads (e.g. daemon threads) will automatically exit
1371 after taking the GIL (in PyEval_RestoreThread()). */
Victor Stinner8e91c242019-04-24 17:24:01 +02001372 runtime->finalizing = tstate;
1373 runtime->initialized = 0;
1374 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001375
Victor Stinnere0deff32015-03-24 13:46:18 +01001376 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001377 if (flush_std_files() < 0) {
1378 status = -1;
1379 }
Nick Coghland6009512014-11-20 21:39:37 +10001380
1381 /* Disable signal handling */
1382 PyOS_FiniInterrupts();
1383
1384 /* Collect garbage. This may call finalizers; it's nice to call these
1385 * before all modules are destroyed.
1386 * XXX If a __del__ or weakref callback is triggered here, and tries to
1387 * XXX import a module, bad things can happen, because Python no
1388 * XXX longer believes it's initialized.
1389 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1390 * XXX is easy to provoke that way. I've also seen, e.g.,
1391 * XXX Exception exceptions.ImportError: 'No module named sha'
1392 * XXX in <function callback at 0x008F5718> ignored
1393 * XXX but I'm unclear on exactly how that one happens. In any case,
1394 * XXX I haven't seen a real-life report of either of these.
1395 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001396 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001397#ifdef COUNT_ALLOCS
1398 /* With COUNT_ALLOCS, it helps to run GC multiple times:
1399 each collection might release some types from the type
1400 list, so they become garbage. */
Łukasz Langafef7e942016-09-09 21:47:46 -07001401 while (_PyGC_CollectIfEnabled() > 0)
Nick Coghland6009512014-11-20 21:39:37 +10001402 /* nothing */;
1403#endif
Eric Snowdae02762017-09-14 00:35:58 -07001404
Steve Dowerb82e17e2019-05-23 08:45:22 -07001405 /* Clear all loghooks */
1406 /* We want minimal exposure of this function, so define the extern
1407 * here. The linker should discover the correct function without
1408 * exporting a symbol. */
1409 extern void _PySys_ClearAuditHooks(void);
1410 _PySys_ClearAuditHooks();
1411
Nick Coghland6009512014-11-20 21:39:37 +10001412 /* Destroy all modules */
Victor Stinner987a0dc2019-06-19 10:36:10 +02001413 _PyImport_Cleanup(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001414
Inada Naoki91234a12019-06-03 21:30:58 +09001415 /* Print debug stats if any */
1416 _PyEval_Fini();
1417
Victor Stinnere0deff32015-03-24 13:46:18 +01001418 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001419 if (flush_std_files() < 0) {
1420 status = -1;
1421 }
Nick Coghland6009512014-11-20 21:39:37 +10001422
1423 /* Collect final garbage. This disposes of cycles created by
1424 * class definitions, for example.
1425 * XXX This is disabled because it caused too many problems. If
1426 * XXX a __del__ or weakref callback triggers here, Python code has
1427 * XXX a hard time running, because even the sys module has been
1428 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1429 * XXX One symptom is a sequence of information-free messages
1430 * XXX coming from threads (if a __del__ or callback is invoked,
1431 * XXX other threads can execute too, and any exception they encounter
1432 * XXX triggers a comedy of errors as subsystem after subsystem
1433 * XXX fails to find what it *expects* to find in sys to help report
1434 * XXX the exception and consequent unexpected failures). I've also
1435 * XXX seen segfaults then, after adding print statements to the
1436 * XXX Python code getting called.
1437 */
1438#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001439 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001440#endif
1441
1442 /* Disable tracemalloc after all Python objects have been destroyed,
1443 so it is possible to use tracemalloc in objects destructor. */
1444 _PyTraceMalloc_Fini();
1445
1446 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1447 _PyImport_Fini();
1448
1449 /* Cleanup typeobject.c's internal caches. */
1450 _PyType_Fini();
1451
1452 /* unload faulthandler module */
1453 _PyFaulthandler_Fini();
1454
1455 /* Debugging stuff */
1456#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001457 _Py_dump_counts(stderr);
Nick Coghland6009512014-11-20 21:39:37 +10001458#endif
1459 /* dump hash stats */
1460 _PyHash_Fini();
1461
Eric Snowdae02762017-09-14 00:35:58 -07001462#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001463 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001464 _PyDebug_PrintTotalRefs();
1465 }
Eric Snowdae02762017-09-14 00:35:58 -07001466#endif
Nick Coghland6009512014-11-20 21:39:37 +10001467
1468#ifdef Py_TRACE_REFS
1469 /* Display all objects still alive -- this can invoke arbitrary
1470 * __repr__ overrides, so requires a mostly-intact interpreter.
1471 * Alas, a lot of stuff may still be alive now that will be cleaned
1472 * up later.
1473 */
Victor Stinnerda273412017-12-15 01:46:02 +01001474 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001475 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001476 }
Nick Coghland6009512014-11-20 21:39:37 +10001477#endif /* Py_TRACE_REFS */
1478
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001479 finalize_interp_clear(tstate);
1480 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001481
1482#ifdef Py_TRACE_REFS
1483 /* Display addresses (& refcnts) of all objects still alive.
1484 * An address can be used to find the repr of the object, printed
1485 * above by _Py_PrintReferences.
1486 */
Victor Stinnerda273412017-12-15 01:46:02 +01001487 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001488 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001489 }
Nick Coghland6009512014-11-20 21:39:37 +10001490#endif /* Py_TRACE_REFS */
Victor Stinner34be8072016-03-14 12:04:26 +01001491#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001492 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001493 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be8072016-03-14 12:04:26 +01001494 }
Nick Coghland6009512014-11-20 21:39:37 +10001495#endif
1496
Victor Stinner8e91c242019-04-24 17:24:01 +02001497 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001498
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001499 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001500 return status;
1501}
1502
1503void
1504Py_Finalize(void)
1505{
1506 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001507}
1508
Victor Stinnerb0051362019-11-22 17:52:42 +01001509
Nick Coghland6009512014-11-20 21:39:37 +10001510/* Create and initialize a new interpreter and thread, and return the
1511 new thread. This requires that Py_Initialize() has been called
1512 first.
1513
1514 Unsuccessful initialization yields a NULL pointer. Note that *no*
1515 exception information is available even in this case -- the
1516 exception information is held in the thread, and there is no
1517 thread.
1518
1519 Locking: as above.
1520
1521*/
1522
Victor Stinner331a6a52019-05-27 16:39:22 +02001523static PyStatus
Victor Stinnera7368ac2017-11-15 18:11:45 -08001524new_interpreter(PyThreadState **tstate_p)
Nick Coghland6009512014-11-20 21:39:37 +10001525{
Victor Stinner331a6a52019-05-27 16:39:22 +02001526 PyStatus status;
Nick Coghland6009512014-11-20 21:39:37 +10001527
Victor Stinner331a6a52019-05-27 16:39:22 +02001528 status = _PyRuntime_Initialize();
1529 if (_PyStatus_EXCEPTION(status)) {
1530 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001531 }
1532 _PyRuntimeState *runtime = &_PyRuntime;
1533
1534 if (!runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001535 return _PyStatus_ERR("Py_Initialize must be called first");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001536 }
Nick Coghland6009512014-11-20 21:39:37 +10001537
Victor Stinner8a1be612016-03-14 22:07:55 +01001538 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1539 interpreters: disable PyGILState_Check(). */
1540 _PyGILState_check_enabled = 0;
1541
Victor Stinner43125222019-04-24 18:23:53 +02001542 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001543 if (interp == NULL) {
1544 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001545 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001546 }
Nick Coghland6009512014-11-20 21:39:37 +10001547
Victor Stinner43125222019-04-24 18:23:53 +02001548 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001549 if (tstate == NULL) {
1550 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001551 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001552 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001553 }
1554
Victor Stinner43125222019-04-24 18:23:53 +02001555 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001556
Eric Snow1abcf672017-05-23 21:46:51 -07001557 /* Copy the current interpreter config into the new interpreter */
Victor Stinner331a6a52019-05-27 16:39:22 +02001558 PyConfig *config;
Eric Snow1abcf672017-05-23 21:46:51 -07001559 if (save_tstate != NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001560 config = &save_tstate->interp->config;
Eric Snow1abcf672017-05-23 21:46:51 -07001561 } else {
1562 /* No current thread state, copy from the main interpreter */
1563 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinner331a6a52019-05-27 16:39:22 +02001564 config = &main_interp->config;
Victor Stinnerda273412017-12-15 01:46:02 +01001565 }
1566
Victor Stinner331a6a52019-05-27 16:39:22 +02001567 status = _PyConfig_Copy(&interp->config, config);
1568 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001569 goto error;
Victor Stinnerda273412017-12-15 01:46:02 +01001570 }
Eric Snow1abcf672017-05-23 21:46:51 -07001571
Victor Stinnerd863ade2019-12-06 03:37:07 +01001572 status = pycore_interp_init(tstate);
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001573 if (_PyStatus_EXCEPTION(status)) {
1574 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001575 }
1576
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001577 status = init_interp_main(tstate);
1578 if (_PyStatus_EXCEPTION(status)) {
1579 goto error;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001580 }
Nick Coghland6009512014-11-20 21:39:37 +10001581
Victor Stinnera7368ac2017-11-15 18:11:45 -08001582 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +02001583 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001584
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001585error:
Victor Stinnerb0051362019-11-22 17:52:42 +01001586 *tstate_p = NULL;
1587
1588 /* Oops, it didn't work. Undo it all. */
Nick Coghland6009512014-11-20 21:39:37 +10001589 PyErr_PrintEx(0);
1590 PyThreadState_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001591 PyThreadState_Delete(tstate);
1592 PyInterpreterState_Delete(interp);
Victor Stinner9da74302019-11-20 11:17:17 +01001593 PyThreadState_Swap(save_tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001594
Victor Stinnerb0051362019-11-22 17:52:42 +01001595 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001596}
1597
1598PyThreadState *
1599Py_NewInterpreter(void)
1600{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001601 PyThreadState *tstate = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001602 PyStatus status = new_interpreter(&tstate);
1603 if (_PyStatus_EXCEPTION(status)) {
1604 Py_ExitStatusException(status);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001605 }
1606 return tstate;
1607
Nick Coghland6009512014-11-20 21:39:37 +10001608}
1609
1610/* Delete an interpreter and its last thread. This requires that the
1611 given thread state is current, that the thread has no remaining
1612 frames, and that it is its interpreter's only remaining thread.
1613 It is a fatal error to violate these constraints.
1614
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001615 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001616 everything, regardless.)
1617
1618 Locking: as above.
1619
1620*/
1621
1622void
1623Py_EndInterpreter(PyThreadState *tstate)
1624{
1625 PyInterpreterState *interp = tstate->interp;
1626
Victor Stinnerb45d2592019-06-20 00:05:23 +02001627 if (tstate != _PyThreadState_GET()) {
Nick Coghland6009512014-11-20 21:39:37 +10001628 Py_FatalError("Py_EndInterpreter: thread is not current");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001629 }
1630 if (tstate->frame != NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001631 Py_FatalError("Py_EndInterpreter: thread still has a frame");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001632 }
Eric Snow5be45a62019-03-08 22:47:07 -07001633 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001634
Eric Snow842a2f02019-03-15 15:47:51 -06001635 // Wrap up existing "threading"-module-created, non-daemon threads.
Victor Stinnerb45d2592019-06-20 00:05:23 +02001636 wait_for_thread_shutdown(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001637
Victor Stinnerb45d2592019-06-20 00:05:23 +02001638 call_py_exitfuncs(tstate);
Marcel Plch776407f2017-12-20 11:17:58 +01001639
Victor Stinnerb45d2592019-06-20 00:05:23 +02001640 if (tstate != interp->tstate_head || tstate->next != NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001641 Py_FatalError("Py_EndInterpreter: not the last thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001642 }
Nick Coghland6009512014-11-20 21:39:37 +10001643
Victor Stinner987a0dc2019-06-19 10:36:10 +02001644 _PyImport_Cleanup(tstate);
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001645 finalize_interp_clear(tstate);
1646 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001647}
1648
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001649/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001650
Victor Stinner331a6a52019-05-27 16:39:22 +02001651static PyStatus
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001652add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001653{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001654 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001655 m = PyImport_AddModule("__main__");
1656 if (m == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +02001657 return _PyStatus_ERR("can't create __main__ module");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001658
Nick Coghland6009512014-11-20 21:39:37 +10001659 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001660 ann_dict = PyDict_New();
1661 if ((ann_dict == NULL) ||
1662 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001663 return _PyStatus_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001664 }
1665 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001666
Nick Coghland6009512014-11-20 21:39:37 +10001667 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1668 PyObject *bimod = PyImport_ImportModule("builtins");
1669 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001670 return _PyStatus_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001671 }
1672 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001673 return _PyStatus_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001674 }
1675 Py_DECREF(bimod);
1676 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001677
Nick Coghland6009512014-11-20 21:39:37 +10001678 /* Main is a little special - imp.is_builtin("__main__") will return
1679 * False, but BuiltinImporter is still the most appropriate initial
1680 * setting for its __loader__ attribute. A more suitable value will
1681 * be set if __main__ gets further initialized later in the startup
1682 * process.
1683 */
1684 loader = PyDict_GetItemString(d, "__loader__");
1685 if (loader == NULL || loader == Py_None) {
1686 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1687 "BuiltinImporter");
1688 if (loader == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001689 return _PyStatus_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001690 }
1691 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001692 return _PyStatus_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001693 }
1694 Py_DECREF(loader);
1695 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001696 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001697}
1698
Nick Coghland6009512014-11-20 21:39:37 +10001699/* Import the site module (not into __main__ though) */
1700
Victor Stinner331a6a52019-05-27 16:39:22 +02001701static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001702init_import_site(void)
Nick Coghland6009512014-11-20 21:39:37 +10001703{
1704 PyObject *m;
1705 m = PyImport_ImportModule("site");
1706 if (m == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001707 return _PyStatus_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001708 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001709 Py_DECREF(m);
Victor Stinner331a6a52019-05-27 16:39:22 +02001710 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001711}
1712
Victor Stinner874dbe82015-09-04 17:29:57 +02001713/* Check if a file descriptor is valid or not.
1714 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1715static int
1716is_valid_fd(int fd)
1717{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001718/* dup() is faster than fstat(): fstat() can require input/output operations,
1719 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1720 startup. Problem: dup() doesn't check if the file descriptor is valid on
1721 some platforms.
1722
1723 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1724 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1725 EBADF. FreeBSD has similar issue (bpo-32849).
1726
1727 Only use dup() on platforms where dup() is enough to detect invalid FD in
1728 corner cases: on Linux and Windows (bpo-32849). */
1729#if defined(__linux__) || defined(MS_WINDOWS)
1730 if (fd < 0) {
1731 return 0;
1732 }
1733 int fd2;
1734
1735 _Py_BEGIN_SUPPRESS_IPH
1736 fd2 = dup(fd);
1737 if (fd2 >= 0) {
1738 close(fd2);
1739 }
1740 _Py_END_SUPPRESS_IPH
1741
1742 return (fd2 >= 0);
1743#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001744 struct stat st;
1745 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001746#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001747}
1748
1749/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001750static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02001751create_stdio(const PyConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001752 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001753 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001754{
1755 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1756 const char* mode;
1757 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001758 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001759 int buffering, isatty;
1760 _Py_IDENTIFIER(open);
1761 _Py_IDENTIFIER(isatty);
1762 _Py_IDENTIFIER(TextIOWrapper);
1763 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001764 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001765
Victor Stinner874dbe82015-09-04 17:29:57 +02001766 if (!is_valid_fd(fd))
1767 Py_RETURN_NONE;
1768
Nick Coghland6009512014-11-20 21:39:37 +10001769 /* stdin is always opened in buffered mode, first because it shouldn't
1770 make a difference in common use cases, second because TextIOWrapper
1771 depends on the presence of a read1() method which only exists on
1772 buffered streams.
1773 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001774 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001775 buffering = 0;
1776 else
1777 buffering = -1;
1778 if (write_mode)
1779 mode = "wb";
1780 else
1781 mode = "rb";
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001782 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOO",
Nick Coghland6009512014-11-20 21:39:37 +10001783 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001784 Py_None, Py_None, /* encoding, errors */
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001785 Py_None, Py_False); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001786 if (buf == NULL)
1787 goto error;
1788
1789 if (buffering) {
1790 _Py_IDENTIFIER(raw);
1791 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1792 if (raw == NULL)
1793 goto error;
1794 }
1795 else {
1796 raw = buf;
1797 Py_INCREF(raw);
1798 }
1799
Steve Dower39294992016-08-30 21:22:36 -07001800#ifdef MS_WINDOWS
1801 /* Windows console IO is always UTF-8 encoded */
1802 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001803 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001804#endif
1805
Nick Coghland6009512014-11-20 21:39:37 +10001806 text = PyUnicode_FromString(name);
1807 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1808 goto error;
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001809 res = _PyObject_CallMethodIdNoArgs(raw, &PyId_isatty);
Nick Coghland6009512014-11-20 21:39:37 +10001810 if (res == NULL)
1811 goto error;
1812 isatty = PyObject_IsTrue(res);
1813 Py_DECREF(res);
1814 if (isatty == -1)
1815 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001816 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001817 write_through = Py_True;
1818 else
1819 write_through = Py_False;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001820 if (isatty && buffered_stdio)
Nick Coghland6009512014-11-20 21:39:37 +10001821 line_buffering = Py_True;
1822 else
1823 line_buffering = Py_False;
1824
1825 Py_CLEAR(raw);
1826 Py_CLEAR(text);
1827
1828#ifdef MS_WINDOWS
1829 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1830 newlines to "\n".
1831 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1832 newline = NULL;
1833#else
1834 /* sys.stdin: split lines at "\n".
1835 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1836 newline = "\n";
1837#endif
1838
Victor Stinner709d23d2019-05-02 14:56:30 -04001839 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1840 if (encoding_str == NULL) {
1841 Py_CLEAR(buf);
1842 goto error;
1843 }
1844
1845 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1846 if (errors_str == NULL) {
1847 Py_CLEAR(buf);
1848 Py_CLEAR(encoding_str);
1849 goto error;
1850 }
1851
1852 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1853 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001854 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001855 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001856 Py_CLEAR(encoding_str);
1857 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001858 if (stream == NULL)
1859 goto error;
1860
1861 if (write_mode)
1862 mode = "w";
1863 else
1864 mode = "r";
1865 text = PyUnicode_FromString(mode);
1866 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1867 goto error;
1868 Py_CLEAR(text);
1869 return stream;
1870
1871error:
1872 Py_XDECREF(buf);
1873 Py_XDECREF(stream);
1874 Py_XDECREF(text);
1875 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001876
Victor Stinner874dbe82015-09-04 17:29:57 +02001877 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1878 /* Issue #24891: the file descriptor was closed after the first
1879 is_valid_fd() check was called. Ignore the OSError and set the
1880 stream to None. */
1881 PyErr_Clear();
1882 Py_RETURN_NONE;
1883 }
1884 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001885}
1886
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001887/* Set builtins.open to io.OpenWrapper */
1888static PyStatus
1889init_set_builtins_open(PyThreadState *tstate)
1890{
1891 PyObject *iomod = NULL, *wrapper;
1892 PyObject *bimod = NULL;
1893 PyStatus res = _PyStatus_OK();
1894
1895 if (!(iomod = PyImport_ImportModule("io"))) {
1896 goto error;
1897 }
1898
1899 if (!(bimod = PyImport_ImportModule("builtins"))) {
1900 goto error;
1901 }
1902
1903 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1904 goto error;
1905 }
1906
1907 /* Set builtins.open */
1908 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1909 Py_DECREF(wrapper);
1910 goto error;
1911 }
1912 Py_DECREF(wrapper);
1913 goto done;
1914
1915error:
1916 res = _PyStatus_ERR("can't initialize io.open");
1917
1918done:
1919 Py_XDECREF(bimod);
1920 Py_XDECREF(iomod);
1921 return res;
1922}
1923
1924
Nick Coghland6009512014-11-20 21:39:37 +10001925/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinner331a6a52019-05-27 16:39:22 +02001926static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001927init_sys_streams(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10001928{
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001929 PyObject *iomod = NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001930 PyObject *m;
1931 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001932 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001933 PyObject * encoding_attr;
Victor Stinner331a6a52019-05-27 16:39:22 +02001934 PyStatus res = _PyStatus_OK();
Victor Stinnerb45d2592019-06-20 00:05:23 +02001935 const PyConfig *config = &tstate->interp->config;
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001936
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001937 /* Check that stdin is not a directory
1938 Using shell redirection, you can redirect stdin to a directory,
1939 crashing the Python interpreter. Catch this common mistake here
1940 and output a useful error message. Note that under MS Windows,
1941 the shell already prevents that. */
1942#ifndef MS_WINDOWS
1943 struct _Py_stat_struct sb;
1944 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1945 S_ISDIR(sb.st_mode)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001946 return _PyStatus_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001947 }
1948#endif
1949
Nick Coghland6009512014-11-20 21:39:37 +10001950 /* Hack to avoid a nasty recursion issue when Python is invoked
1951 in verbose mode: pre-import the Latin-1 and UTF-8 codecs */
1952 if ((m = PyImport_ImportModule("encodings.utf_8")) == NULL) {
1953 goto error;
1954 }
1955 Py_DECREF(m);
1956
1957 if (!(m = PyImport_ImportModule("encodings.latin_1"))) {
1958 goto error;
1959 }
1960 Py_DECREF(m);
1961
Nick Coghland6009512014-11-20 21:39:37 +10001962 if (!(iomod = PyImport_ImportModule("io"))) {
1963 goto error;
1964 }
Nick Coghland6009512014-11-20 21:39:37 +10001965
Nick Coghland6009512014-11-20 21:39:37 +10001966 /* Set sys.stdin */
1967 fd = fileno(stdin);
1968 /* Under some conditions stdin, stdout and stderr may not be connected
1969 * and fileno() may point to an invalid file descriptor. For example
1970 * GUI apps don't have valid standard streams by default.
1971 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001972 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001973 config->stdio_encoding,
1974 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001975 if (std == NULL)
1976 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001977 PySys_SetObject("__stdin__", std);
1978 _PySys_SetObjectId(&PyId_stdin, std);
1979 Py_DECREF(std);
1980
1981 /* Set sys.stdout */
1982 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001983 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001984 config->stdio_encoding,
1985 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001986 if (std == NULL)
1987 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001988 PySys_SetObject("__stdout__", std);
1989 _PySys_SetObjectId(&PyId_stdout, std);
1990 Py_DECREF(std);
1991
1992#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
1993 /* Set sys.stderr, replaces the preliminary stderr */
1994 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001995 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001996 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04001997 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02001998 if (std == NULL)
1999 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10002000
2001 /* Same as hack above, pre-import stderr's codec to avoid recursion
2002 when import.c tries to write to stderr in verbose mode. */
2003 encoding_attr = PyObject_GetAttrString(std, "encoding");
2004 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02002005 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10002006 if (std_encoding != NULL) {
2007 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
2008 Py_XDECREF(codec_info);
2009 }
2010 Py_DECREF(encoding_attr);
2011 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02002012 _PyErr_Clear(tstate); /* Not a fatal error if codec isn't available */
Nick Coghland6009512014-11-20 21:39:37 +10002013
2014 if (PySys_SetObject("__stderr__", std) < 0) {
2015 Py_DECREF(std);
2016 goto error;
2017 }
2018 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
2019 Py_DECREF(std);
2020 goto error;
2021 }
2022 Py_DECREF(std);
2023#endif
2024
Victor Stinnera7368ac2017-11-15 18:11:45 -08002025 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10002026
Victor Stinnera7368ac2017-11-15 18:11:45 -08002027error:
Victor Stinner331a6a52019-05-27 16:39:22 +02002028 res = _PyStatus_ERR("can't initialize sys standard streams");
Victor Stinnera7368ac2017-11-15 18:11:45 -08002029
2030done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02002031 _Py_ClearStandardStreamEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10002032 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08002033 return res;
Nick Coghland6009512014-11-20 21:39:37 +10002034}
2035
2036
Victor Stinner10dc4842015-03-24 12:01:30 +01002037static void
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002038_Py_FatalError_DumpTracebacks(int fd, PyInterpreterState *interp,
2039 PyThreadState *tstate)
Victor Stinner10dc4842015-03-24 12:01:30 +01002040{
Victor Stinner10dc4842015-03-24 12:01:30 +01002041 fputc('\n', stderr);
2042 fflush(stderr);
2043
2044 /* display the current Python stack */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002045 _Py_DumpTracebackThreads(fd, interp, tstate);
Victor Stinner10dc4842015-03-24 12:01:30 +01002046}
Victor Stinner791da1c2016-03-14 16:53:12 +01002047
2048/* Print the current exception (if an exception is set) with its traceback,
2049 or display the current Python stack.
2050
2051 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
2052 called on catastrophic cases.
2053
2054 Return 1 if the traceback was displayed, 0 otherwise. */
2055
2056static int
2057_Py_FatalError_PrintExc(int fd)
2058{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002059 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner791da1c2016-03-14 16:53:12 +01002060 PyObject *ferr, *res;
2061 PyObject *exception, *v, *tb;
2062 int has_tb;
2063
Victor Stinnerb45d2592019-06-20 00:05:23 +02002064 _PyErr_Fetch(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002065 if (exception == NULL) {
2066 /* No current exception */
2067 return 0;
2068 }
2069
2070 ferr = _PySys_GetObjectId(&PyId_stderr);
2071 if (ferr == NULL || ferr == Py_None) {
2072 /* sys.stderr is not set yet or set to None,
2073 no need to try to display the exception */
2074 return 0;
2075 }
2076
Victor Stinnerb45d2592019-06-20 00:05:23 +02002077 _PyErr_NormalizeException(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002078 if (tb == NULL) {
2079 tb = Py_None;
2080 Py_INCREF(tb);
2081 }
2082 PyException_SetTraceback(v, tb);
2083 if (exception == NULL) {
2084 /* PyErr_NormalizeException() failed */
2085 return 0;
2086 }
2087
2088 has_tb = (tb != Py_None);
2089 PyErr_Display(exception, v, tb);
2090 Py_XDECREF(exception);
2091 Py_XDECREF(v);
2092 Py_XDECREF(tb);
2093
2094 /* sys.stderr may be buffered: call sys.stderr.flush() */
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002095 res = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002096 if (res == NULL) {
2097 _PyErr_Clear(tstate);
2098 }
2099 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002100 Py_DECREF(res);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002101 }
Victor Stinner791da1c2016-03-14 16:53:12 +01002102
2103 return has_tb;
2104}
2105
Nick Coghland6009512014-11-20 21:39:37 +10002106/* Print fatal error message and abort */
2107
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002108#ifdef MS_WINDOWS
2109static void
2110fatal_output_debug(const char *msg)
2111{
2112 /* buffer of 256 bytes allocated on the stack */
2113 WCHAR buffer[256 / sizeof(WCHAR)];
2114 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2115 size_t msglen;
2116
2117 OutputDebugStringW(L"Fatal Python error: ");
2118
2119 msglen = strlen(msg);
2120 while (msglen) {
2121 size_t i;
2122
2123 if (buflen > msglen) {
2124 buflen = msglen;
2125 }
2126
2127 /* Convert the message to wchar_t. This uses a simple one-to-one
2128 conversion, assuming that the this error message actually uses
2129 ASCII only. If this ceases to be true, we will have to convert. */
2130 for (i=0; i < buflen; ++i) {
2131 buffer[i] = msg[i];
2132 }
2133 buffer[i] = L'\0';
2134 OutputDebugStringW(buffer);
2135
2136 msg += buflen;
2137 msglen -= buflen;
2138 }
2139 OutputDebugStringW(L"\n");
2140}
2141#endif
2142
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002143
2144static void
2145fatal_error_dump_runtime(FILE *stream, _PyRuntimeState *runtime)
2146{
2147 fprintf(stream, "Python runtime state: ");
2148 if (runtime->finalizing) {
2149 fprintf(stream, "finalizing (tstate=%p)", runtime->finalizing);
2150 }
2151 else if (runtime->initialized) {
2152 fprintf(stream, "initialized");
2153 }
2154 else if (runtime->core_initialized) {
2155 fprintf(stream, "core initialized");
2156 }
2157 else if (runtime->preinitialized) {
2158 fprintf(stream, "preinitialized");
2159 }
2160 else if (runtime->preinitializing) {
2161 fprintf(stream, "preinitializing");
2162 }
2163 else {
2164 fprintf(stream, "unknown");
2165 }
2166 fprintf(stream, "\n");
2167 fflush(stream);
2168}
2169
2170
Benjamin Petersoncef88b92017-11-25 13:02:55 -08002171static void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002172fatal_error(const char *prefix, const char *msg, int status)
Nick Coghland6009512014-11-20 21:39:37 +10002173{
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002174 FILE *stream = stderr;
2175 const int fd = fileno(stream);
Victor Stinner53345a42015-03-25 01:55:14 +01002176 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002177
2178 if (reentrant) {
2179 /* Py_FatalError() caused a second fatal error.
2180 Example: flush_std_files() raises a recursion error. */
2181 goto exit;
2182 }
2183 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002184
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002185 fprintf(stream, "Fatal Python error: ");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002186 if (prefix) {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002187 fputs(prefix, stream);
2188 fputs(": ", stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002189 }
2190 if (msg) {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002191 fputs(msg, stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002192 }
2193 else {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002194 fprintf(stream, "<message not set>");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002195 }
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002196 fputs("\n", stream);
2197 fflush(stream); /* it helps in Windows debug build */
2198
2199 _PyRuntimeState *runtime = &_PyRuntime;
2200 fatal_error_dump_runtime(stream, runtime);
2201
2202 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
2203 PyInterpreterState *interp = NULL;
2204 if (tstate != NULL) {
2205 interp = tstate->interp;
2206 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002207
Victor Stinner3a228ab2018-11-01 00:26:41 +01002208 /* Check if the current thread has a Python thread state
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002209 and holds the GIL.
Victor Stinner3a228ab2018-11-01 00:26:41 +01002210
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002211 tss_tstate is NULL if Py_FatalError() is called from a C thread which
2212 has no Python thread state.
2213
2214 tss_tstate != tstate if the current Python thread does not hold the GIL.
2215 */
2216 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2217 int has_tstate_and_gil = (tss_tstate != NULL && tss_tstate == tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002218 if (has_tstate_and_gil) {
2219 /* If an exception is set, print the exception with its traceback */
2220 if (!_Py_FatalError_PrintExc(fd)) {
2221 /* No exception is set, or an exception is set without traceback */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002222 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002223 }
2224 }
2225 else {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002226 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002227 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002228
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002229 /* The main purpose of faulthandler is to display the traceback.
2230 This function already did its best to display a traceback.
2231 Disable faulthandler to prevent writing a second traceback
2232 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002233 _PyFaulthandler_Fini();
2234
Victor Stinner791da1c2016-03-14 16:53:12 +01002235 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002236 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002237 /* Flush sys.stdout and sys.stderr */
2238 flush_std_files();
2239 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002240
Nick Coghland6009512014-11-20 21:39:37 +10002241#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002242 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002243#endif /* MS_WINDOWS */
2244
2245exit:
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002246 if (status < 0) {
Victor Stinner53345a42015-03-25 01:55:14 +01002247#if defined(MS_WINDOWS) && defined(_DEBUG)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002248 DebugBreak();
Nick Coghland6009512014-11-20 21:39:37 +10002249#endif
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002250 abort();
2251 }
2252 else {
2253 exit(status);
2254 }
2255}
2256
Victor Stinner19760862017-12-20 01:41:59 +01002257void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002258Py_FatalError(const char *msg)
2259{
2260 fatal_error(NULL, msg, -1);
2261}
2262
Victor Stinner19760862017-12-20 01:41:59 +01002263void _Py_NO_RETURN
Victor Stinner331a6a52019-05-27 16:39:22 +02002264Py_ExitStatusException(PyStatus status)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002265{
Victor Stinner331a6a52019-05-27 16:39:22 +02002266 if (_PyStatus_IS_EXIT(status)) {
2267 exit(status.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002268 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002269 else if (_PyStatus_IS_ERROR(status)) {
2270 fatal_error(status.func, status.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002271 }
2272 else {
Victor Stinner331a6a52019-05-27 16:39:22 +02002273 Py_FatalError("Py_ExitStatusException() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002274 }
Nick Coghland6009512014-11-20 21:39:37 +10002275}
2276
2277/* Clean up and exit */
2278
Victor Stinnerd7292b52016-06-17 12:29:00 +02002279# include "pythread.h"
Nick Coghland6009512014-11-20 21:39:37 +10002280
Nick Coghland6009512014-11-20 21:39:37 +10002281/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002282void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002283{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002284 PyInterpreterState *is = _PyInterpreterState_GET_UNSAFE();
Marcel Plch776407f2017-12-20 11:17:58 +01002285
Antoine Pitroufc5db952017-12-13 02:29:07 +01002286 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002287 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2288
2289 is->pyexitfunc = func;
2290 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002291}
2292
2293static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002294call_py_exitfuncs(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002295{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002296 PyInterpreterState *interp = tstate->interp;
2297 if (interp->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002298 return;
2299
Victor Stinnerb45d2592019-06-20 00:05:23 +02002300 (*interp->pyexitfunc)(interp->pyexitmodule);
2301 _PyErr_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10002302}
2303
2304/* Wait until threading._shutdown completes, provided
2305 the threading module was imported in the first place.
2306 The shutdown routine will wait until all non-daemon
2307 "threading" threads have completed. */
2308static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002309wait_for_thread_shutdown(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002310{
Nick Coghland6009512014-11-20 21:39:37 +10002311 _Py_IDENTIFIER(_shutdown);
2312 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002313 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002314 if (threading == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +02002315 if (_PyErr_Occurred(tstate)) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002316 PyErr_WriteUnraisable(NULL);
2317 }
2318 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002319 return;
2320 }
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002321 result = _PyObject_CallMethodIdNoArgs(threading, &PyId__shutdown);
Nick Coghland6009512014-11-20 21:39:37 +10002322 if (result == NULL) {
2323 PyErr_WriteUnraisable(threading);
2324 }
2325 else {
2326 Py_DECREF(result);
2327 }
2328 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002329}
2330
2331#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002332int Py_AtExit(void (*func)(void))
2333{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002334 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002335 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002336 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002337 return 0;
2338}
2339
2340static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002341call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002342{
Victor Stinner8e91c242019-04-24 17:24:01 +02002343 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002344 /* pop last function from the list */
2345 runtime->nexitfuncs--;
2346 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2347 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2348
2349 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002350 }
Nick Coghland6009512014-11-20 21:39:37 +10002351
2352 fflush(stdout);
2353 fflush(stderr);
2354}
2355
Victor Stinnercfc88312018-08-01 16:41:25 +02002356void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002357Py_Exit(int sts)
2358{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002359 if (Py_FinalizeEx() < 0) {
2360 sts = 120;
2361 }
Nick Coghland6009512014-11-20 21:39:37 +10002362
2363 exit(sts);
2364}
2365
Victor Stinner331a6a52019-05-27 16:39:22 +02002366static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02002367init_signals(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002368{
2369#ifdef SIGPIPE
2370 PyOS_setsig(SIGPIPE, SIG_IGN);
2371#endif
2372#ifdef SIGXFZ
2373 PyOS_setsig(SIGXFZ, SIG_IGN);
2374#endif
2375#ifdef SIGXFSZ
2376 PyOS_setsig(SIGXFSZ, SIG_IGN);
2377#endif
2378 PyOS_InitInterrupts(); /* May imply initsignal() */
Victor Stinnerb45d2592019-06-20 00:05:23 +02002379 if (_PyErr_Occurred(tstate)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002380 return _PyStatus_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002381 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002382 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002383}
2384
2385
2386/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2387 *
2388 * All of the code in this function must only use async-signal-safe functions,
2389 * listed at `man 7 signal` or
2390 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2391 */
2392void
2393_Py_RestoreSignals(void)
2394{
2395#ifdef SIGPIPE
2396 PyOS_setsig(SIGPIPE, SIG_DFL);
2397#endif
2398#ifdef SIGXFZ
2399 PyOS_setsig(SIGXFZ, SIG_DFL);
2400#endif
2401#ifdef SIGXFSZ
2402 PyOS_setsig(SIGXFSZ, SIG_DFL);
2403#endif
2404}
2405
2406
2407/*
2408 * The file descriptor fd is considered ``interactive'' if either
2409 * a) isatty(fd) is TRUE, or
2410 * b) the -i flag was given, and the filename associated with
2411 * the descriptor is NULL or "<stdin>" or "???".
2412 */
2413int
2414Py_FdIsInteractive(FILE *fp, const char *filename)
2415{
2416 if (isatty((int)fileno(fp)))
2417 return 1;
2418 if (!Py_InteractiveFlag)
2419 return 0;
2420 return (filename == NULL) ||
2421 (strcmp(filename, "<stdin>") == 0) ||
2422 (strcmp(filename, "???") == 0);
2423}
2424
2425
Nick Coghland6009512014-11-20 21:39:37 +10002426/* Wrappers around sigaction() or signal(). */
2427
2428PyOS_sighandler_t
2429PyOS_getsig(int sig)
2430{
2431#ifdef HAVE_SIGACTION
2432 struct sigaction context;
2433 if (sigaction(sig, NULL, &context) == -1)
2434 return SIG_ERR;
2435 return context.sa_handler;
2436#else
2437 PyOS_sighandler_t handler;
2438/* Special signal handling for the secure CRT in Visual Studio 2005 */
2439#if defined(_MSC_VER) && _MSC_VER >= 1400
2440 switch (sig) {
2441 /* Only these signals are valid */
2442 case SIGINT:
2443 case SIGILL:
2444 case SIGFPE:
2445 case SIGSEGV:
2446 case SIGTERM:
2447 case SIGBREAK:
2448 case SIGABRT:
2449 break;
2450 /* Don't call signal() with other values or it will assert */
2451 default:
2452 return SIG_ERR;
2453 }
2454#endif /* _MSC_VER && _MSC_VER >= 1400 */
2455 handler = signal(sig, SIG_IGN);
2456 if (handler != SIG_ERR)
2457 signal(sig, handler);
2458 return handler;
2459#endif
2460}
2461
2462/*
2463 * All of the code in this function must only use async-signal-safe functions,
2464 * listed at `man 7 signal` or
2465 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2466 */
2467PyOS_sighandler_t
2468PyOS_setsig(int sig, PyOS_sighandler_t handler)
2469{
2470#ifdef HAVE_SIGACTION
2471 /* Some code in Modules/signalmodule.c depends on sigaction() being
2472 * used here if HAVE_SIGACTION is defined. Fix that if this code
2473 * changes to invalidate that assumption.
2474 */
2475 struct sigaction context, ocontext;
2476 context.sa_handler = handler;
2477 sigemptyset(&context.sa_mask);
2478 context.sa_flags = 0;
2479 if (sigaction(sig, &context, &ocontext) == -1)
2480 return SIG_ERR;
2481 return ocontext.sa_handler;
2482#else
2483 PyOS_sighandler_t oldhandler;
2484 oldhandler = signal(sig, handler);
2485#ifdef HAVE_SIGINTERRUPT
2486 siginterrupt(sig, 1);
2487#endif
2488 return oldhandler;
2489#endif
2490}
2491
2492#ifdef __cplusplus
2493}
2494#endif