blob: c154d060ad8d98dd31f38c5b958771d74c9bc649 [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 Stinner331a6a52019-05-27 16:39:22 +02009#include "pycore_initconfig.h"
Victor Stinner353933e2018-11-23 13:08:26 +010010#include "pycore_fileutils.h"
Victor Stinner27e2d1f2018-11-01 00:52:28 +010011#include "pycore_hamt.h"
Victor Stinnera1c249c2018-11-01 03:15:58 +010012#include "pycore_pathconfig.h"
Victor Stinner621cebe2018-11-12 16:53:38 +010013#include "pycore_pylifecycle.h"
14#include "pycore_pymem.h"
15#include "pycore_pystate.h"
Victor Stinnered488662019-05-20 00:14:57 +020016#include "pycore_traceback.h"
Nick Coghland6009512014-11-20 21:39:37 +100017#include "grammar.h"
18#include "node.h"
19#include "token.h"
20#include "parsetok.h"
21#include "errcode.h"
22#include "code.h"
23#include "symtable.h"
24#include "ast.h"
25#include "marshal.h"
26#include "osdefs.h"
27#include <locale.h>
28
29#ifdef HAVE_SIGNAL_H
30#include <signal.h>
31#endif
32
33#ifdef MS_WINDOWS
34#include "malloc.h" /* for alloca */
35#endif
36
37#ifdef HAVE_LANGINFO_H
38#include <langinfo.h>
39#endif
40
41#ifdef MS_WINDOWS
42#undef BYTE
43#include "windows.h"
Steve Dower39294992016-08-30 21:22:36 -070044
45extern PyTypeObject PyWindowsConsoleIO_Type;
46#define PyWindowsConsoleIO_Check(op) (PyObject_TypeCheck((op), &PyWindowsConsoleIO_Type))
Nick Coghland6009512014-11-20 21:39:37 +100047#endif
48
49_Py_IDENTIFIER(flush);
50_Py_IDENTIFIER(name);
51_Py_IDENTIFIER(stdin);
52_Py_IDENTIFIER(stdout);
53_Py_IDENTIFIER(stderr);
Eric Snow3f9eee62017-09-15 16:35:20 -060054_Py_IDENTIFIER(threading);
Nick Coghland6009512014-11-20 21:39:37 +100055
56#ifdef __cplusplus
57extern "C" {
58#endif
59
Nick Coghland6009512014-11-20 21:39:37 +100060extern grammar _PyParser_Grammar; /* From graminit.c */
61
62/* Forward */
Victor Stinner331a6a52019-05-27 16:39:22 +020063static PyStatus add_main_module(PyInterpreterState *interp);
64static PyStatus init_import_size(void);
65static PyStatus init_sys_streams(PyInterpreterState *interp);
66static PyStatus init_signals(void);
Marcel Plch776407f2017-12-20 11:17:58 +010067static void call_py_exitfuncs(PyInterpreterState *);
Nick Coghland6009512014-11-20 21:39:37 +100068static void wait_for_thread_shutdown(void);
Victor Stinner8e91c242019-04-24 17:24:01 +020069static void call_ll_exitfuncs(_PyRuntimeState *runtime);
Nick Coghland6009512014-11-20 21:39:37 +100070
Gregory P. Smith38f11cc2019-02-16 12:57:40 -080071int _Py_UnhandledKeyboardInterrupt = 0;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080072_PyRuntimeState _PyRuntime = _PyRuntimeState_INIT;
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010073static int runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060074
Victor Stinner331a6a52019-05-27 16:39:22 +020075PyStatus
Eric Snow2ebc5ce2017-09-07 23:51:28 -060076_PyRuntime_Initialize(void)
77{
78 /* XXX We only initialize once in the process, which aligns with
79 the static initialization of the former globals now found in
80 _PyRuntime. However, _PyRuntime *should* be initialized with
81 every Py_Initialize() call, but doing so breaks the runtime.
82 This is because the runtime state is not properly finalized
83 currently. */
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010084 if (runtime_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +020085 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -080086 }
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010087 runtime_initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080088
89 return _PyRuntimeState_Init(&_PyRuntime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -060090}
91
92void
93_PyRuntime_Finalize(void)
94{
95 _PyRuntimeState_Fini(&_PyRuntime);
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010096 runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060097}
98
99int
100_Py_IsFinalizing(void)
101{
102 return _PyRuntime.finalizing != NULL;
103}
104
Nick Coghland6009512014-11-20 21:39:37 +1000105/* Hack to force loading of object files */
106int (*_PyOS_mystrnicmp_hack)(const char *, const char *, Py_ssize_t) = \
107 PyOS_mystrnicmp; /* Python/pystrcmp.o */
108
109/* PyModule_GetWarningsModule is no longer necessary as of 2.6
110since _warnings is builtin. This API should not be used. */
111PyObject *
112PyModule_GetWarningsModule(void)
113{
114 return PyImport_ImportModule("warnings");
115}
116
Eric Snowc7ec9982017-05-23 23:00:52 -0700117
Eric Snow1abcf672017-05-23 21:46:51 -0700118/* APIs to access the initialization flags
119 *
120 * Can be called prior to Py_Initialize.
121 */
Nick Coghland6009512014-11-20 21:39:37 +1000122
Eric Snow1abcf672017-05-23 21:46:51 -0700123int
124_Py_IsCoreInitialized(void)
125{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600126 return _PyRuntime.core_initialized;
Eric Snow1abcf672017-05-23 21:46:51 -0700127}
Nick Coghland6009512014-11-20 21:39:37 +1000128
129int
130Py_IsInitialized(void)
131{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600132 return _PyRuntime.initialized;
Nick Coghland6009512014-11-20 21:39:37 +1000133}
134
Nick Coghlan6ea41862017-06-11 13:16:15 +1000135
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000136/* Global initializations. Can be undone by Py_FinalizeEx(). Don't
137 call this twice without an intervening Py_FinalizeEx() call. When
Nick Coghland6009512014-11-20 21:39:37 +1000138 initializations fail, a fatal error is issued and the function does
139 not return. On return, the first thread and interpreter state have
140 been created.
141
142 Locking: you must hold the interpreter lock while calling this.
143 (If the lock has not yet been initialized, that's equivalent to
144 having the lock, but you cannot use multiple threads.)
145
146*/
147
Victor Stinner331a6a52019-05-27 16:39:22 +0200148static PyStatus
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400149init_importlib(PyInterpreterState *interp, PyObject *sysmod)
Nick Coghland6009512014-11-20 21:39:37 +1000150{
151 PyObject *importlib;
152 PyObject *impmod;
Nick Coghland6009512014-11-20 21:39:37 +1000153 PyObject *value;
Victor Stinner331a6a52019-05-27 16:39:22 +0200154 int verbose = interp->config.verbose;
Nick Coghland6009512014-11-20 21:39:37 +1000155
156 /* Import _importlib through its frozen version, _frozen_importlib. */
157 if (PyImport_ImportFrozenModule("_frozen_importlib") <= 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200158 return _PyStatus_ERR("can't import _frozen_importlib");
Nick Coghland6009512014-11-20 21:39:37 +1000159 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200160 else if (verbose) {
Nick Coghland6009512014-11-20 21:39:37 +1000161 PySys_FormatStderr("import _frozen_importlib # frozen\n");
162 }
163 importlib = PyImport_AddModule("_frozen_importlib");
164 if (importlib == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200165 return _PyStatus_ERR("couldn't get _frozen_importlib from sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000166 }
167 interp->importlib = importlib;
168 Py_INCREF(interp->importlib);
169
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300170 interp->import_func = PyDict_GetItemString(interp->builtins, "__import__");
171 if (interp->import_func == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +0200172 return _PyStatus_ERR("__import__ not found");
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300173 Py_INCREF(interp->import_func);
174
Victor Stinnercd6e6942015-09-18 09:11:57 +0200175 /* Import the _imp module */
Benjamin Petersonc65ef772018-01-29 11:33:57 -0800176 impmod = PyInit__imp();
Nick Coghland6009512014-11-20 21:39:37 +1000177 if (impmod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200178 return _PyStatus_ERR("can't import _imp");
Nick Coghland6009512014-11-20 21:39:37 +1000179 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200180 else if (verbose) {
Victor Stinnercd6e6942015-09-18 09:11:57 +0200181 PySys_FormatStderr("import _imp # builtin\n");
Nick Coghland6009512014-11-20 21:39:37 +1000182 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600183 if (_PyImport_SetModuleString("_imp", impmod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200184 return _PyStatus_ERR("can't save _imp to sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000185 }
186
Victor Stinnercd6e6942015-09-18 09:11:57 +0200187 /* Install importlib as the implementation of import */
Nick Coghland6009512014-11-20 21:39:37 +1000188 value = PyObject_CallMethod(importlib, "_install", "OO", sysmod, impmod);
189 if (value == NULL) {
190 PyErr_Print();
Victor Stinner331a6a52019-05-27 16:39:22 +0200191 return _PyStatus_ERR("importlib install failed");
Nick Coghland6009512014-11-20 21:39:37 +1000192 }
193 Py_DECREF(value);
194 Py_DECREF(impmod);
195
Victor Stinner331a6a52019-05-27 16:39:22 +0200196 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000197}
198
Victor Stinner331a6a52019-05-27 16:39:22 +0200199static PyStatus
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400200init_importlib_external(PyInterpreterState *interp)
Eric Snow1abcf672017-05-23 21:46:51 -0700201{
202 PyObject *value;
203 value = PyObject_CallMethod(interp->importlib,
204 "_install_external_importers", "");
205 if (value == NULL) {
206 PyErr_Print();
Victor Stinner331a6a52019-05-27 16:39:22 +0200207 return _PyStatus_ERR("external importer setup failed");
Eric Snow1abcf672017-05-23 21:46:51 -0700208 }
Stéphane Wirtelab1cb802017-06-08 13:13:20 +0200209 Py_DECREF(value);
Victor Stinner410b85a2019-05-13 17:12:45 +0200210 return _PyImportZip_Init(interp);
Eric Snow1abcf672017-05-23 21:46:51 -0700211}
Nick Coghland6009512014-11-20 21:39:37 +1000212
Nick Coghlan6ea41862017-06-11 13:16:15 +1000213/* Helper functions to better handle the legacy C locale
214 *
215 * The legacy C locale assumes ASCII as the default text encoding, which
216 * causes problems not only for the CPython runtime, but also other
217 * components like GNU readline.
218 *
219 * Accordingly, when the CLI detects it, it attempts to coerce it to a
220 * more capable UTF-8 based alternative as follows:
221 *
222 * if (_Py_LegacyLocaleDetected()) {
223 * _Py_CoerceLegacyLocale();
224 * }
225 *
226 * See the documentation of the PYTHONCOERCECLOCALE setting for more details.
227 *
228 * Locale coercion also impacts the default error handler for the standard
229 * streams: while the usual default is "strict", the default for the legacy
230 * C locale and for any of the coercion target locales is "surrogateescape".
231 */
232
233int
Victor Stinner0f721472019-05-20 17:16:38 +0200234_Py_LegacyLocaleDetected(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000235{
236#ifndef MS_WINDOWS
Victor Stinner0f721472019-05-20 17:16:38 +0200237 if (!warn) {
238 const char *locale_override = getenv("LC_ALL");
239 if (locale_override != NULL && *locale_override != '\0') {
240 /* Don't coerce C locale if the LC_ALL environment variable
241 is set */
242 return 0;
243 }
244 }
245
Nick Coghlan6ea41862017-06-11 13:16:15 +1000246 /* On non-Windows systems, the C locale is considered a legacy locale */
Nick Coghlaneb817952017-06-18 12:29:42 +1000247 /* XXX (ncoghlan): some platforms (notably Mac OS X) don't appear to treat
248 * the POSIX locale as a simple alias for the C locale, so
249 * we may also want to check for that explicitly.
250 */
Nick Coghlan6ea41862017-06-11 13:16:15 +1000251 const char *ctype_loc = setlocale(LC_CTYPE, NULL);
252 return ctype_loc != NULL && strcmp(ctype_loc, "C") == 0;
253#else
254 /* Windows uses code pages instead of locales, so no locale is legacy */
255 return 0;
256#endif
257}
258
Nick Coghlaneb817952017-06-18 12:29:42 +1000259static const char *_C_LOCALE_WARNING =
260 "Python runtime initialized with LC_CTYPE=C (a locale with default ASCII "
261 "encoding), which may cause Unicode compatibility problems. Using C.UTF-8, "
262 "C.utf8, or UTF-8 (if available) as alternative Unicode-compatible "
263 "locales is recommended.\n";
264
Nick Coghlaneb817952017-06-18 12:29:42 +1000265static void
Victor Stinner43125222019-04-24 18:23:53 +0200266emit_stderr_warning_for_legacy_locale(_PyRuntimeState *runtime)
Nick Coghlaneb817952017-06-18 12:29:42 +1000267{
Victor Stinner331a6a52019-05-27 16:39:22 +0200268 const PyPreConfig *preconfig = &runtime->preconfig;
Victor Stinner0f721472019-05-20 17:16:38 +0200269 if (preconfig->coerce_c_locale_warn && _Py_LegacyLocaleDetected(1)) {
Victor Stinnercf215042018-08-29 22:56:06 +0200270 PySys_FormatStderr("%s", _C_LOCALE_WARNING);
Nick Coghlaneb817952017-06-18 12:29:42 +1000271 }
272}
273
Nick Coghlan6ea41862017-06-11 13:16:15 +1000274typedef struct _CandidateLocale {
275 const char *locale_name; /* The locale to try as a coercion target */
276} _LocaleCoercionTarget;
277
278static _LocaleCoercionTarget _TARGET_LOCALES[] = {
279 {"C.UTF-8"},
280 {"C.utf8"},
Nick Coghlan18974c32017-06-30 00:48:14 +1000281 {"UTF-8"},
Nick Coghlan6ea41862017-06-11 13:16:15 +1000282 {NULL}
283};
284
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200285
286int
287_Py_IsLocaleCoercionTarget(const char *ctype_loc)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000288{
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200289 const _LocaleCoercionTarget *target = NULL;
290 for (target = _TARGET_LOCALES; target->locale_name; target++) {
291 if (strcmp(ctype_loc, target->locale_name) == 0) {
292 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000293 }
Victor Stinner124b9eb2018-08-29 01:29:06 +0200294 }
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200295 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000296}
297
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200298
Nick Coghlan6ea41862017-06-11 13:16:15 +1000299#ifdef PY_COERCE_C_LOCALE
Victor Stinner94540602017-12-16 04:54:22 +0100300static const char C_LOCALE_COERCION_WARNING[] =
Nick Coghlan6ea41862017-06-11 13:16:15 +1000301 "Python detected LC_CTYPE=C: LC_CTYPE coerced to %.20s (set another locale "
302 "or PYTHONCOERCECLOCALE=0 to disable this locale coercion behavior).\n";
303
Victor Stinner0f721472019-05-20 17:16:38 +0200304static int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200305_coerce_default_locale_settings(int warn, const _LocaleCoercionTarget *target)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000306{
307 const char *newloc = target->locale_name;
308
309 /* Reset locale back to currently configured defaults */
xdegaye1588be62017-11-12 12:45:59 +0100310 _Py_SetLocaleFromEnv(LC_ALL);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000311
312 /* Set the relevant locale environment variable */
313 if (setenv("LC_CTYPE", newloc, 1)) {
314 fprintf(stderr,
315 "Error setting LC_CTYPE, skipping C locale coercion\n");
Victor Stinner0f721472019-05-20 17:16:38 +0200316 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000317 }
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200318 if (warn) {
Victor Stinner94540602017-12-16 04:54:22 +0100319 fprintf(stderr, C_LOCALE_COERCION_WARNING, newloc);
Nick Coghlaneb817952017-06-18 12:29:42 +1000320 }
Nick Coghlan6ea41862017-06-11 13:16:15 +1000321
322 /* Reconfigure with the overridden environment variables */
xdegaye1588be62017-11-12 12:45:59 +0100323 _Py_SetLocaleFromEnv(LC_ALL);
Victor Stinner0f721472019-05-20 17:16:38 +0200324 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000325}
326#endif
327
Victor Stinner0f721472019-05-20 17:16:38 +0200328int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200329_Py_CoerceLegacyLocale(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000330{
Victor Stinner0f721472019-05-20 17:16:38 +0200331 int coerced = 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000332#ifdef PY_COERCE_C_LOCALE
Victor Stinner8ea09112018-09-03 17:05:18 +0200333 char *oldloc = NULL;
334
335 oldloc = _PyMem_RawStrdup(setlocale(LC_CTYPE, NULL));
336 if (oldloc == NULL) {
Victor Stinner0f721472019-05-20 17:16:38 +0200337 return coerced;
Victor Stinner8ea09112018-09-03 17:05:18 +0200338 }
339
Victor Stinner94540602017-12-16 04:54:22 +0100340 const char *locale_override = getenv("LC_ALL");
341 if (locale_override == NULL || *locale_override == '\0') {
342 /* LC_ALL is also not set (or is set to an empty string) */
343 const _LocaleCoercionTarget *target = NULL;
344 for (target = _TARGET_LOCALES; target->locale_name; target++) {
345 const char *new_locale = setlocale(LC_CTYPE,
346 target->locale_name);
347 if (new_locale != NULL) {
Victor Stinnere2510952019-05-02 11:28:57 -0400348#if !defined(_Py_FORCE_UTF8_LOCALE) && defined(HAVE_LANGINFO_H) && defined(CODESET)
Victor Stinner94540602017-12-16 04:54:22 +0100349 /* Also ensure that nl_langinfo works in this locale */
350 char *codeset = nl_langinfo(CODESET);
351 if (!codeset || *codeset == '\0') {
352 /* CODESET is not set or empty, so skip coercion */
353 new_locale = NULL;
354 _Py_SetLocaleFromEnv(LC_CTYPE);
355 continue;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000356 }
Victor Stinner94540602017-12-16 04:54:22 +0100357#endif
358 /* Successfully configured locale, so make it the default */
Victor Stinner0f721472019-05-20 17:16:38 +0200359 coerced = _coerce_default_locale_settings(warn, target);
Victor Stinner8ea09112018-09-03 17:05:18 +0200360 goto done;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000361 }
362 }
363 }
364 /* No C locale warning here, as Py_Initialize will emit one later */
Victor Stinner8ea09112018-09-03 17:05:18 +0200365
366 setlocale(LC_CTYPE, oldloc);
367
368done:
369 PyMem_RawFree(oldloc);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000370#endif
Victor Stinner0f721472019-05-20 17:16:38 +0200371 return coerced;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000372}
373
xdegaye1588be62017-11-12 12:45:59 +0100374/* _Py_SetLocaleFromEnv() is a wrapper around setlocale(category, "") to
375 * isolate the idiosyncrasies of different libc implementations. It reads the
376 * appropriate environment variable and uses its value to select the locale for
377 * 'category'. */
378char *
379_Py_SetLocaleFromEnv(int category)
380{
Victor Stinner353933e2018-11-23 13:08:26 +0100381 char *res;
xdegaye1588be62017-11-12 12:45:59 +0100382#ifdef __ANDROID__
383 const char *locale;
384 const char **pvar;
385#ifdef PY_COERCE_C_LOCALE
386 const char *coerce_c_locale;
387#endif
388 const char *utf8_locale = "C.UTF-8";
389 const char *env_var_set[] = {
390 "LC_ALL",
391 "LC_CTYPE",
392 "LANG",
393 NULL,
394 };
395
396 /* Android setlocale(category, "") doesn't check the environment variables
397 * and incorrectly sets the "C" locale at API 24 and older APIs. We only
398 * check the environment variables listed in env_var_set. */
399 for (pvar=env_var_set; *pvar; pvar++) {
400 locale = getenv(*pvar);
401 if (locale != NULL && *locale != '\0') {
402 if (strcmp(locale, utf8_locale) == 0 ||
403 strcmp(locale, "en_US.UTF-8") == 0) {
404 return setlocale(category, utf8_locale);
405 }
406 return setlocale(category, "C");
407 }
408 }
409
410 /* Android uses UTF-8, so explicitly set the locale to C.UTF-8 if none of
411 * LC_ALL, LC_CTYPE, or LANG is set to a non-empty string.
412 * Quote from POSIX section "8.2 Internationalization Variables":
413 * "4. If the LANG environment variable is not set or is set to the empty
414 * string, the implementation-defined default locale shall be used." */
415
416#ifdef PY_COERCE_C_LOCALE
417 coerce_c_locale = getenv("PYTHONCOERCECLOCALE");
418 if (coerce_c_locale == NULL || strcmp(coerce_c_locale, "0") != 0) {
419 /* Some other ported code may check the environment variables (e.g. in
420 * extension modules), so we make sure that they match the locale
421 * configuration */
422 if (setenv("LC_CTYPE", utf8_locale, 1)) {
423 fprintf(stderr, "Warning: failed setting the LC_CTYPE "
424 "environment variable to %s\n", utf8_locale);
425 }
426 }
427#endif
Victor Stinner353933e2018-11-23 13:08:26 +0100428 res = setlocale(category, utf8_locale);
429#else /* !defined(__ANDROID__) */
430 res = setlocale(category, "");
431#endif
432 _Py_ResetForceASCII();
433 return res;
xdegaye1588be62017-11-12 12:45:59 +0100434}
435
Nick Coghlan6ea41862017-06-11 13:16:15 +1000436
Eric Snow1abcf672017-05-23 21:46:51 -0700437/* Global initializations. Can be undone by Py_Finalize(). Don't
438 call this twice without an intervening Py_Finalize() call.
439
Victor Stinner331a6a52019-05-27 16:39:22 +0200440 Every call to Py_InitializeFromConfig, Py_Initialize or Py_InitializeEx
Eric Snow1abcf672017-05-23 21:46:51 -0700441 must have a corresponding call to Py_Finalize.
442
443 Locking: you must hold the interpreter lock while calling these APIs.
444 (If the lock has not yet been initialized, that's equivalent to
445 having the lock, but you cannot use multiple threads.)
446
447*/
448
Victor Stinner331a6a52019-05-27 16:39:22 +0200449static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200450pyinit_core_reconfigure(_PyRuntimeState *runtime,
451 PyInterpreterState **interp_p,
Victor Stinner331a6a52019-05-27 16:39:22 +0200452 const PyConfig *config)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200453{
Victor Stinner331a6a52019-05-27 16:39:22 +0200454 PyStatus status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100455 PyThreadState *tstate = _PyThreadState_GET();
456 if (!tstate) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200457 return _PyStatus_ERR("failed to read thread state");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100458 }
459
460 PyInterpreterState *interp = tstate->interp;
461 if (interp == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200462 return _PyStatus_ERR("can't make main interpreter");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100463 }
464 *interp_p = interp;
465
Victor Stinner331a6a52019-05-27 16:39:22 +0200466 _PyConfig_Write(config, runtime);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200467
Victor Stinner331a6a52019-05-27 16:39:22 +0200468 status = _PyConfig_Copy(&interp->config, config);
469 if (_PyStatus_EXCEPTION(status)) {
470 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200471 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200472 config = &interp->config;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200473
Victor Stinner331a6a52019-05-27 16:39:22 +0200474 if (config->_install_importlib) {
Victor Stinner96c84752019-09-26 16:17:34 +0200475 status = _PyConfig_WritePathConfig(config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200476 if (_PyStatus_EXCEPTION(status)) {
477 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200478 }
479 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200480 return _PyStatus_OK();
Victor Stinner1dc6e392018-07-25 02:49:17 +0200481}
482
483
Victor Stinner331a6a52019-05-27 16:39:22 +0200484static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200485pycore_init_runtime(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200486 const PyConfig *config)
Nick Coghland6009512014-11-20 21:39:37 +1000487{
Victor Stinner43125222019-04-24 18:23:53 +0200488 if (runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200489 return _PyStatus_ERR("main interpreter already initialized");
Victor Stinner1dc6e392018-07-25 02:49:17 +0200490 }
Victor Stinnerda273412017-12-15 01:46:02 +0100491
Victor Stinner331a6a52019-05-27 16:39:22 +0200492 _PyConfig_Write(config, runtime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600493
Eric Snow1abcf672017-05-23 21:46:51 -0700494 /* Py_Finalize leaves _Py_Finalizing set in order to help daemon
495 * threads behave a little more gracefully at interpreter shutdown.
496 * We clobber it here so the new interpreter can start with a clean
497 * slate.
498 *
499 * However, this may still lead to misbehaviour if there are daemon
500 * threads still hanging around from a previous Py_Initialize/Finalize
501 * pair :(
502 */
Victor Stinner43125222019-04-24 18:23:53 +0200503 runtime->finalizing = NULL;
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600504
Victor Stinner331a6a52019-05-27 16:39:22 +0200505 PyStatus status = _Py_HashRandomization_Init(config);
506 if (_PyStatus_EXCEPTION(status)) {
507 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800508 }
509
Victor Stinner331a6a52019-05-27 16:39:22 +0200510 status = _PyInterpreterState_Enable(runtime);
511 if (_PyStatus_EXCEPTION(status)) {
512 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -0800513 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200514 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100515}
Victor Stinnera7368ac2017-11-15 18:11:45 -0800516
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100517
Victor Stinner331a6a52019-05-27 16:39:22 +0200518static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200519pycore_create_interpreter(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200520 const PyConfig *config,
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100521 PyInterpreterState **interp_p)
522{
523 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnerda273412017-12-15 01:46:02 +0100524 if (interp == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200525 return _PyStatus_ERR("can't make main interpreter");
Victor Stinnerda273412017-12-15 01:46:02 +0100526 }
Victor Stinner1dc6e392018-07-25 02:49:17 +0200527 *interp_p = interp;
Victor Stinnerda273412017-12-15 01:46:02 +0100528
Victor Stinner331a6a52019-05-27 16:39:22 +0200529 PyStatus status = _PyConfig_Copy(&interp->config, config);
530 if (_PyStatus_EXCEPTION(status)) {
531 return status;
Victor Stinnerda273412017-12-15 01:46:02 +0100532 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200533 config = &interp->config;
Nick Coghland6009512014-11-20 21:39:37 +1000534
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200535 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +1000536 if (tstate == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +0200537 return _PyStatus_ERR("can't make first thread");
Nick Coghland6009512014-11-20 21:39:37 +1000538 (void) PyThreadState_Swap(tstate);
539
Victor Stinner99fcc612019-04-29 13:04:07 +0200540 /* We can't call _PyEval_FiniThreads() in Py_FinalizeEx because
541 destroying the GIL might fail when it is being referenced from
542 another running thread (see issue #9901).
Nick Coghland6009512014-11-20 21:39:37 +1000543 Instead we destroy the previously created GIL here, which ensures
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000544 that we can call Py_Initialize / Py_FinalizeEx multiple times. */
Victor Stinner09532fe2019-05-10 23:39:09 +0200545 _PyEval_FiniThreads(&runtime->ceval);
Victor Stinner2914bb32018-01-29 11:57:45 +0100546
Nick Coghland6009512014-11-20 21:39:37 +1000547 /* Auto-thread-state API */
Victor Stinner0fd2c302019-06-04 03:15:09 +0200548 _PyGILState_Init(runtime, interp, tstate);
Nick Coghland6009512014-11-20 21:39:37 +1000549
Victor Stinner2914bb32018-01-29 11:57:45 +0100550 /* Create the GIL */
551 PyEval_InitThreads();
552
Victor Stinner331a6a52019-05-27 16:39:22 +0200553 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100554}
Nick Coghland6009512014-11-20 21:39:37 +1000555
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100556
Victor Stinner331a6a52019-05-27 16:39:22 +0200557static PyStatus
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100558pycore_init_types(void)
559{
Victor Stinner331a6a52019-05-27 16:39:22 +0200560 PyStatus status = _PyTypes_Init();
561 if (_PyStatus_EXCEPTION(status)) {
562 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100563 }
564
Victor Stinner331a6a52019-05-27 16:39:22 +0200565 status = _PyUnicode_Init();
566 if (_PyStatus_EXCEPTION(status)) {
567 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100568 }
569
570 if (_PyStructSequence_Init() < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200571 return _PyStatus_ERR("can't initialize structseq");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100572 }
573
574 if (!_PyLong_Init()) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200575 return _PyStatus_ERR("can't init longs");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100576 }
Nick Coghland6009512014-11-20 21:39:37 +1000577
Victor Stinner331a6a52019-05-27 16:39:22 +0200578 status = _PyExc_Init();
579 if (_PyStatus_EXCEPTION(status)) {
580 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100581 }
582
583 if (!_PyFloat_Init()) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200584 return _PyStatus_ERR("can't init float");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100585 }
Nick Coghland6009512014-11-20 21:39:37 +1000586
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100587 if (!_PyContext_Init()) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200588 return _PyStatus_ERR("can't init context");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100589 }
Victor Stinneref9d9b62019-05-22 11:28:22 +0200590
Victor Stinner331a6a52019-05-27 16:39:22 +0200591 status = _PyErr_Init();
592 if (_PyStatus_EXCEPTION(status)) {
593 return status;
Victor Stinneref9d9b62019-05-22 11:28:22 +0200594 }
595
Victor Stinner331a6a52019-05-27 16:39:22 +0200596 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100597}
598
599
Victor Stinner331a6a52019-05-27 16:39:22 +0200600static PyStatus
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100601pycore_init_builtins(PyInterpreterState *interp)
602{
603 PyObject *bimod = _PyBuiltin_Init();
604 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200605 return _PyStatus_ERR("can't initialize builtins modules");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100606 }
607 _PyImport_FixupBuiltin(bimod, "builtins", interp->modules);
608
609 interp->builtins = PyModule_GetDict(bimod);
610 if (interp->builtins == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200611 return _PyStatus_ERR("can't initialize builtins dict");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100612 }
613 Py_INCREF(interp->builtins);
614
Victor Stinner331a6a52019-05-27 16:39:22 +0200615 PyStatus status = _PyBuiltins_AddExceptions(bimod);
616 if (_PyStatus_EXCEPTION(status)) {
617 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100618 }
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 Stinner6d43f6f2019-01-22 21:18:05 +0100624pycore_init_import_warnings(PyInterpreterState *interp, PyObject *sysmod)
625{
Victor Stinner9f3dcf82019-09-21 02:13:14 +0200626 const PyConfig *config = &interp->config;
627
Victor Stinner331a6a52019-05-27 16:39:22 +0200628 PyStatus status = _PyImport_Init(interp);
629 if (_PyStatus_EXCEPTION(status)) {
630 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800631 }
Nick Coghland6009512014-11-20 21:39:37 +1000632
Victor Stinner331a6a52019-05-27 16:39:22 +0200633 status = _PyImportHooks_Init();
634 if (_PyStatus_EXCEPTION(status)) {
635 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800636 }
Nick Coghland6009512014-11-20 21:39:37 +1000637
638 /* Initialize _warnings. */
Victor Stinner5d862462017-12-19 11:35:58 +0100639 if (_PyWarnings_Init() == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200640 return _PyStatus_ERR("can't initialize warnings");
Victor Stinner1f151112017-11-23 10:43:14 +0100641 }
Nick Coghland6009512014-11-20 21:39:37 +1000642
Victor Stinner9f3dcf82019-09-21 02:13:14 +0200643 if (config->_install_importlib) {
Victor Stinner96c84752019-09-26 16:17:34 +0200644 status = _PyConfig_WritePathConfig(config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200645 if (_PyStatus_EXCEPTION(status)) {
646 return status;
Victor Stinnerb1147e42018-07-21 02:06:16 +0200647 }
648 }
649
Eric Snow1abcf672017-05-23 21:46:51 -0700650 /* This call sets up builtin and frozen import support */
Victor Stinner9f3dcf82019-09-21 02:13:14 +0200651 if (config->_install_importlib) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200652 status = init_importlib(interp, sysmod);
653 if (_PyStatus_EXCEPTION(status)) {
654 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800655 }
Eric Snow1abcf672017-05-23 21:46:51 -0700656 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200657 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100658}
659
660
Victor Stinner331a6a52019-05-27 16:39:22 +0200661static PyStatus
662pyinit_config(_PyRuntimeState *runtime,
663 PyInterpreterState **interp_p,
664 const PyConfig *config)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100665{
666 PyInterpreterState *interp;
667
Victor Stinner331a6a52019-05-27 16:39:22 +0200668 _PyConfig_Write(config, runtime);
Victor Stinner20004952019-03-26 02:31:11 +0100669
Victor Stinner331a6a52019-05-27 16:39:22 +0200670 PyStatus status = pycore_init_runtime(runtime, config);
671 if (_PyStatus_EXCEPTION(status)) {
672 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100673 }
674
Victor Stinner331a6a52019-05-27 16:39:22 +0200675 status = pycore_create_interpreter(runtime, config, &interp);
676 if (_PyStatus_EXCEPTION(status)) {
677 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100678 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200679 config = &interp->config;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100680 *interp_p = interp;
681
Victor Stinner331a6a52019-05-27 16:39:22 +0200682 status = pycore_init_types();
683 if (_PyStatus_EXCEPTION(status)) {
684 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100685 }
686
687 PyObject *sysmod;
Victor Stinner0fd2c302019-06-04 03:15:09 +0200688 status = _PySys_Create(runtime, interp, &sysmod);
Victor Stinner331a6a52019-05-27 16:39:22 +0200689 if (_PyStatus_EXCEPTION(status)) {
690 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100691 }
692
Victor Stinner331a6a52019-05-27 16:39:22 +0200693 status = pycore_init_builtins(interp);
694 if (_PyStatus_EXCEPTION(status)) {
695 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100696 }
697
Victor Stinner331a6a52019-05-27 16:39:22 +0200698 status = pycore_init_import_warnings(interp, sysmod);
699 if (_PyStatus_EXCEPTION(status)) {
700 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100701 }
Eric Snow1abcf672017-05-23 21:46:51 -0700702
703 /* Only when we get here is the runtime core fully initialized */
Victor Stinner43125222019-04-24 18:23:53 +0200704 runtime->core_initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200705 return _PyStatus_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700706}
707
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100708
Victor Stinner331a6a52019-05-27 16:39:22 +0200709PyStatus
710_Py_PreInitializeFromPyArgv(const PyPreConfig *src_config, const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100711{
Victor Stinner331a6a52019-05-27 16:39:22 +0200712 PyStatus status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100713
Victor Stinner6d1c4672019-05-20 11:02:00 +0200714 if (src_config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200715 return _PyStatus_ERR("preinitialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +0200716 }
717
Victor Stinner331a6a52019-05-27 16:39:22 +0200718 status = _PyRuntime_Initialize();
719 if (_PyStatus_EXCEPTION(status)) {
720 return status;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100721 }
Victor Stinner43125222019-04-24 18:23:53 +0200722 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100723
Victor Stinner47bbab92019-09-18 14:10:16 +0200724 if (runtime->preinitialized) {
Victor Stinnerf72346c2019-03-25 17:54:58 +0100725 /* If it's already configured: ignored the new configuration */
Victor Stinner331a6a52019-05-27 16:39:22 +0200726 return _PyStatus_OK();
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100727 }
728
Victor Stinner47bbab92019-09-18 14:10:16 +0200729 /* Note: preinitialized remains 1 on error, it is only set to 0
730 at exit on success. */
731 runtime->preinitializing = 1;
732
Victor Stinner331a6a52019-05-27 16:39:22 +0200733 PyPreConfig config;
Victor Stinner6e128382019-09-28 04:50:43 +0200734 config.struct_size = sizeof(PyPreConfig);
735
736 status = _PyPreConfig_InitFromPreConfig(&config, src_config);
737 if (_PyStatus_EXCEPTION(status)) {
738 return status;
739 }
Victor Stinnerf72346c2019-03-25 17:54:58 +0100740
Victor Stinner331a6a52019-05-27 16:39:22 +0200741 status = _PyPreConfig_Read(&config, args);
742 if (_PyStatus_EXCEPTION(status)) {
743 return status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100744 }
745
Victor Stinner331a6a52019-05-27 16:39:22 +0200746 status = _PyPreConfig_Write(&config);
747 if (_PyStatus_EXCEPTION(status)) {
748 return status;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100749 }
750
Victor Stinner47bbab92019-09-18 14:10:16 +0200751 runtime->preinitializing = 0;
752 runtime->preinitialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200753 return _PyStatus_OK();
Victor Stinnerf72346c2019-03-25 17:54:58 +0100754}
755
Victor Stinner70005ac2019-05-02 15:25:34 -0400756
Victor Stinner331a6a52019-05-27 16:39:22 +0200757PyStatus
758Py_PreInitializeFromBytesArgs(const PyPreConfig *src_config, Py_ssize_t argc, char **argv)
Victor Stinnerf72346c2019-03-25 17:54:58 +0100759{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100760 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400761 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100762}
763
764
Victor Stinner331a6a52019-05-27 16:39:22 +0200765PyStatus
766Py_PreInitializeFromArgs(const PyPreConfig *src_config, Py_ssize_t argc, wchar_t **argv)
Victor Stinner20004952019-03-26 02:31:11 +0100767{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100768 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400769 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinner20004952019-03-26 02:31:11 +0100770}
771
772
Victor Stinner331a6a52019-05-27 16:39:22 +0200773PyStatus
774Py_PreInitialize(const PyPreConfig *src_config)
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100775{
Victor Stinner70005ac2019-05-02 15:25:34 -0400776 return _Py_PreInitializeFromPyArgv(src_config, NULL);
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100777}
778
779
Victor Stinner331a6a52019-05-27 16:39:22 +0200780PyStatus
781_Py_PreInitializeFromConfig(const PyConfig *config,
782 const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100783{
Victor Stinner331a6a52019-05-27 16:39:22 +0200784 assert(config != NULL);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200785
Victor Stinner331a6a52019-05-27 16:39:22 +0200786 PyStatus status = _PyRuntime_Initialize();
787 if (_PyStatus_EXCEPTION(status)) {
788 return status;
Victor Stinner6d1c4672019-05-20 11:02:00 +0200789 }
790 _PyRuntimeState *runtime = &_PyRuntime;
791
Victor Stinner47bbab92019-09-18 14:10:16 +0200792 if (runtime->preinitialized) {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200793 /* Already initialized: do nothing */
Victor Stinner331a6a52019-05-27 16:39:22 +0200794 return _PyStatus_OK();
Victor Stinner70005ac2019-05-02 15:25:34 -0400795 }
Victor Stinnercab5d072019-05-17 19:01:14 +0200796
Victor Stinner331a6a52019-05-27 16:39:22 +0200797 PyPreConfig preconfig;
Victor Stinner6e128382019-09-28 04:50:43 +0200798 preconfig.struct_size = sizeof(PyPreConfig);
799
800 status = _PyPreConfig_InitFromConfig(&preconfig, config);
801 if (_PyStatus_EXCEPTION(status)) {
802 return status;
803 }
Victor Stinner6d1c4672019-05-20 11:02:00 +0200804
Victor Stinner331a6a52019-05-27 16:39:22 +0200805 if (!config->parse_argv) {
806 return Py_PreInitialize(&preconfig);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200807 }
808 else if (args == NULL) {
Victor Stinnercab5d072019-05-17 19:01:14 +0200809 _PyArgv config_args = {
810 .use_bytes_argv = 0,
Victor Stinner331a6a52019-05-27 16:39:22 +0200811 .argc = config->argv.length,
812 .wchar_argv = config->argv.items};
Victor Stinner6d1c4672019-05-20 11:02:00 +0200813 return _Py_PreInitializeFromPyArgv(&preconfig, &config_args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200814 }
815 else {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200816 return _Py_PreInitializeFromPyArgv(&preconfig, args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200817 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100818}
819
820
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100821/* Begin interpreter initialization
822 *
823 * On return, the first thread and interpreter state have been created,
824 * but the compiler, signal handling, multithreading and
825 * multiple interpreter support, and codec infrastructure are not yet
826 * available.
827 *
828 * The import system will support builtin and frozen modules only.
829 * The only supported io is writing to sys.stderr
830 *
831 * If any operation invoked by this function fails, a fatal error is
832 * issued and the function does not return.
833 *
834 * Any code invoked from this function should *not* assume it has access
835 * to the Python C API (unless the API is explicitly listed as being
836 * safe to call without calling Py_Initialize first)
837 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200838static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200839pyinit_core(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200840 const PyConfig *src_config,
Victor Stinner5edcf262019-05-23 00:57:57 +0200841 PyInterpreterState **interp_p)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200842{
Victor Stinner331a6a52019-05-27 16:39:22 +0200843 PyStatus status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200844
Victor Stinner331a6a52019-05-27 16:39:22 +0200845 status = _Py_PreInitializeFromConfig(src_config, NULL);
846 if (_PyStatus_EXCEPTION(status)) {
847 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200848 }
849
Victor Stinner331a6a52019-05-27 16:39:22 +0200850 PyConfig config;
Victor Stinner6e128382019-09-28 04:50:43 +0200851 config.struct_size = sizeof(PyConfig);
852
853 status = _PyConfig_InitCompatConfig(&config);
854 if (_PyStatus_EXCEPTION(status)) {
855 goto done;
856 }
Victor Stinner5edcf262019-05-23 00:57:57 +0200857
Victor Stinner331a6a52019-05-27 16:39:22 +0200858 status = _PyConfig_Copy(&config, src_config);
859 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200860 goto done;
861 }
862
Victor Stinner331a6a52019-05-27 16:39:22 +0200863 status = PyConfig_Read(&config);
864 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200865 goto done;
866 }
867
868 if (!runtime->core_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200869 status = pyinit_config(runtime, interp_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200870 }
871 else {
Victor Stinner331a6a52019-05-27 16:39:22 +0200872 status = pyinit_core_reconfigure(runtime, interp_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200873 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200874 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200875 goto done;
876 }
877
878done:
Victor Stinner331a6a52019-05-27 16:39:22 +0200879 PyConfig_Clear(&config);
880 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200881}
882
Victor Stinner5ac27a52019-03-27 13:40:14 +0100883
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200884/* Py_Initialize() has already been called: update the main interpreter
885 configuration. Example of bpo-34008: Py_Main() called after
886 Py_Initialize(). */
Victor Stinner331a6a52019-05-27 16:39:22 +0200887static PyStatus
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100888_Py_ReconfigureMainInterpreter(PyInterpreterState *interp)
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200889{
Victor Stinner331a6a52019-05-27 16:39:22 +0200890 PyConfig *config = &interp->config;
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100891
Victor Stinner331a6a52019-05-27 16:39:22 +0200892 PyObject *argv = _PyWideStringList_AsList(&config->argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100893 if (argv == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200894 return _PyStatus_NO_MEMORY(); \
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100895 }
896
897 int res = PyDict_SetItemString(interp->sysdict, "argv", argv);
898 Py_DECREF(argv);
899 if (res < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200900 return _PyStatus_ERR("fail to set sys.argv");
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200901 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200902 return _PyStatus_OK();
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200903}
904
Eric Snowc7ec9982017-05-23 23:00:52 -0700905/* Update interpreter state based on supplied configuration settings
906 *
907 * After calling this function, most of the restrictions on the interpreter
908 * are lifted. The only remaining incomplete settings are those related
909 * to the main module (sys.argv[0], __main__ metadata)
910 *
911 * Calling this when the interpreter is not initializing, is already
912 * initialized or without a valid current thread state is a fatal error.
913 * Other errors should be reported as normal Python exceptions with a
914 * non-zero return code.
915 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200916static PyStatus
Victor Stinner0fd2c302019-06-04 03:15:09 +0200917pyinit_main(_PyRuntimeState *runtime, PyInterpreterState *interp)
Eric Snow1abcf672017-05-23 21:46:51 -0700918{
Victor Stinner43125222019-04-24 18:23:53 +0200919 if (!runtime->core_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200920 return _PyStatus_ERR("runtime core not initialized");
Eric Snowc7ec9982017-05-23 23:00:52 -0700921 }
Eric Snowc7ec9982017-05-23 23:00:52 -0700922
Victor Stinner1dc6e392018-07-25 02:49:17 +0200923 /* Configure the main interpreter */
Victor Stinner331a6a52019-05-27 16:39:22 +0200924 PyConfig *config = &interp->config;
Eric Snowc7ec9982017-05-23 23:00:52 -0700925
Victor Stinner43125222019-04-24 18:23:53 +0200926 if (runtime->initialized) {
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100927 return _Py_ReconfigureMainInterpreter(interp);
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200928 }
929
Victor Stinner331a6a52019-05-27 16:39:22 +0200930 if (!config->_install_importlib) {
Eric Snow1abcf672017-05-23 21:46:51 -0700931 /* Special mode for freeze_importlib: run with no import system
932 *
933 * This means anything which needs support from extension modules
934 * or pure Python code in the standard library won't work.
935 */
Victor Stinner43125222019-04-24 18:23:53 +0200936 runtime->initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200937 return _PyStatus_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700938 }
Victor Stinner9316ee42017-11-25 03:17:57 +0100939
Victor Stinner33c377e2017-12-05 15:12:41 +0100940 if (_PyTime_Init() < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200941 return _PyStatus_ERR("can't initialize time");
Victor Stinner33c377e2017-12-05 15:12:41 +0100942 }
Victor Stinner13019fd2015-04-03 13:10:54 +0200943
Victor Stinner0fd2c302019-06-04 03:15:09 +0200944 if (_PySys_InitMain(runtime, interp) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200945 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerda273412017-12-15 01:46:02 +0100946 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800947
Victor Stinner331a6a52019-05-27 16:39:22 +0200948 PyStatus status = init_importlib_external(interp);
949 if (_PyStatus_EXCEPTION(status)) {
950 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800951 }
Nick Coghland6009512014-11-20 21:39:37 +1000952
953 /* initialize the faulthandler module */
Victor Stinner331a6a52019-05-27 16:39:22 +0200954 status = _PyFaulthandler_Init(config->faulthandler);
955 if (_PyStatus_EXCEPTION(status)) {
956 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800957 }
Nick Coghland6009512014-11-20 21:39:37 +1000958
Victor Stinnerc5c64252019-09-23 15:59:00 +0200959 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
960 status = _PyUnicode_InitEncodings(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200961 if (_PyStatus_EXCEPTION(status)) {
962 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800963 }
Nick Coghland6009512014-11-20 21:39:37 +1000964
Victor Stinner331a6a52019-05-27 16:39:22 +0200965 if (config->install_signal_handlers) {
966 status = init_signals();
967 if (_PyStatus_EXCEPTION(status)) {
968 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800969 }
970 }
Nick Coghland6009512014-11-20 21:39:37 +1000971
Victor Stinner331a6a52019-05-27 16:39:22 +0200972 if (_PyTraceMalloc_Init(config->tracemalloc) < 0) {
973 return _PyStatus_ERR("can't initialize tracemalloc");
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200974 }
Nick Coghland6009512014-11-20 21:39:37 +1000975
Victor Stinner331a6a52019-05-27 16:39:22 +0200976 status = add_main_module(interp);
977 if (_PyStatus_EXCEPTION(status)) {
978 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800979 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800980
Victor Stinner331a6a52019-05-27 16:39:22 +0200981 status = init_sys_streams(interp);
982 if (_PyStatus_EXCEPTION(status)) {
983 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800984 }
Nick Coghland6009512014-11-20 21:39:37 +1000985
986 /* Initialize warnings. */
Victor Stinner37cd9822018-11-16 11:55:35 +0100987 PyObject *warnoptions = PySys_GetObject("warnoptions");
988 if (warnoptions != NULL && PyList_Size(warnoptions) > 0)
Victor Stinner5d862462017-12-19 11:35:58 +0100989 {
Nick Coghland6009512014-11-20 21:39:37 +1000990 PyObject *warnings_module = PyImport_ImportModule("warnings");
991 if (warnings_module == NULL) {
992 fprintf(stderr, "'import warnings' failed; traceback:\n");
993 PyErr_Print();
994 }
995 Py_XDECREF(warnings_module);
996 }
997
Victor Stinner43125222019-04-24 18:23:53 +0200998 runtime->initialized = 1;
Eric Snow1abcf672017-05-23 21:46:51 -0700999
Victor Stinner331a6a52019-05-27 16:39:22 +02001000 if (config->site_import) {
1001 status = init_import_size(); /* Module site */
1002 if (_PyStatus_EXCEPTION(status)) {
1003 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001004 }
1005 }
Victor Stinnercf215042018-08-29 22:56:06 +02001006
1007#ifndef MS_WINDOWS
Victor Stinner43125222019-04-24 18:23:53 +02001008 emit_stderr_warning_for_legacy_locale(runtime);
Victor Stinnercf215042018-08-29 22:56:06 +02001009#endif
1010
Victor Stinner331a6a52019-05-27 16:39:22 +02001011 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001012}
1013
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001014
Victor Stinner331a6a52019-05-27 16:39:22 +02001015PyStatus
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001016_Py_InitializeMain(void)
1017{
Victor Stinner331a6a52019-05-27 16:39:22 +02001018 PyStatus status = _PyRuntime_Initialize();
1019 if (_PyStatus_EXCEPTION(status)) {
1020 return status;
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001021 }
1022 _PyRuntimeState *runtime = &_PyRuntime;
1023 PyInterpreterState *interp = _PyRuntimeState_GetThreadState(runtime)->interp;
1024
Victor Stinner0fd2c302019-06-04 03:15:09 +02001025 return pyinit_main(runtime, interp);
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001026}
1027
1028
Victor Stinner331a6a52019-05-27 16:39:22 +02001029PyStatus
1030Py_InitializeFromConfig(const PyConfig *config)
Eric Snow1abcf672017-05-23 21:46:51 -07001031{
Victor Stinner6d1c4672019-05-20 11:02:00 +02001032 if (config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001033 return _PyStatus_ERR("initialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +02001034 }
1035
Victor Stinner331a6a52019-05-27 16:39:22 +02001036 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001037
Victor Stinner331a6a52019-05-27 16:39:22 +02001038 status = _PyRuntime_Initialize();
1039 if (_PyStatus_EXCEPTION(status)) {
1040 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001041 }
1042 _PyRuntimeState *runtime = &_PyRuntime;
1043
1044 PyInterpreterState *interp = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001045 status = pyinit_core(runtime, config, &interp);
1046 if (_PyStatus_EXCEPTION(status)) {
1047 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001048 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001049 config = &interp->config;
Victor Stinnerbc8ac6b2017-11-30 18:03:55 +01001050
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001051 if (config->_init_main) {
Victor Stinner0fd2c302019-06-04 03:15:09 +02001052 status = pyinit_main(runtime, interp);
Victor Stinner331a6a52019-05-27 16:39:22 +02001053 if (_PyStatus_EXCEPTION(status)) {
1054 return status;
Victor Stinner484f20d2019-03-27 02:04:16 +01001055 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001056 }
Victor Stinner484f20d2019-03-27 02:04:16 +01001057
Victor Stinner331a6a52019-05-27 16:39:22 +02001058 return _PyStatus_OK();
Victor Stinner5ac27a52019-03-27 13:40:14 +01001059}
1060
1061
Eric Snow1abcf672017-05-23 21:46:51 -07001062void
Nick Coghland6009512014-11-20 21:39:37 +10001063Py_InitializeEx(int install_sigs)
1064{
Victor Stinner331a6a52019-05-27 16:39:22 +02001065 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001066
Victor Stinner331a6a52019-05-27 16:39:22 +02001067 status = _PyRuntime_Initialize();
1068 if (_PyStatus_EXCEPTION(status)) {
1069 Py_ExitStatusException(status);
Victor Stinner43125222019-04-24 18:23:53 +02001070 }
1071 _PyRuntimeState *runtime = &_PyRuntime;
1072
1073 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001074 /* bpo-33932: Calling Py_Initialize() twice does nothing. */
1075 return;
1076 }
1077
Victor Stinner331a6a52019-05-27 16:39:22 +02001078 PyConfig config;
Victor Stinner6e128382019-09-28 04:50:43 +02001079 config.struct_size = sizeof(PyConfig);
1080
1081 status = _PyConfig_InitCompatConfig(&config);
1082 if (_PyStatus_EXCEPTION(status)) {
1083 Py_ExitStatusException(status);
1084 }
1085
Victor Stinner1dc6e392018-07-25 02:49:17 +02001086 config.install_signal_handlers = install_sigs;
1087
Victor Stinner331a6a52019-05-27 16:39:22 +02001088 status = Py_InitializeFromConfig(&config);
1089 if (_PyStatus_EXCEPTION(status)) {
1090 Py_ExitStatusException(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001091 }
Nick Coghland6009512014-11-20 21:39:37 +10001092}
1093
1094void
1095Py_Initialize(void)
1096{
1097 Py_InitializeEx(1);
1098}
1099
1100
1101#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001102extern void _Py_dump_counts(FILE*);
Nick Coghland6009512014-11-20 21:39:37 +10001103#endif
1104
1105/* Flush stdout and stderr */
1106
1107static int
1108file_is_closed(PyObject *fobj)
1109{
1110 int r;
1111 PyObject *tmp = PyObject_GetAttrString(fobj, "closed");
1112 if (tmp == NULL) {
1113 PyErr_Clear();
1114 return 0;
1115 }
1116 r = PyObject_IsTrue(tmp);
1117 Py_DECREF(tmp);
1118 if (r < 0)
1119 PyErr_Clear();
1120 return r > 0;
1121}
1122
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001123static int
Nick Coghland6009512014-11-20 21:39:37 +10001124flush_std_files(void)
1125{
1126 PyObject *fout = _PySys_GetObjectId(&PyId_stdout);
1127 PyObject *ferr = _PySys_GetObjectId(&PyId_stderr);
1128 PyObject *tmp;
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001129 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001130
1131 if (fout != NULL && fout != Py_None && !file_is_closed(fout)) {
Victor Stinner3466bde2016-09-05 18:16:01 -07001132 tmp = _PyObject_CallMethodId(fout, &PyId_flush, NULL);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001133 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001134 PyErr_WriteUnraisable(fout);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001135 status = -1;
1136 }
Nick Coghland6009512014-11-20 21:39:37 +10001137 else
1138 Py_DECREF(tmp);
1139 }
1140
1141 if (ferr != NULL && ferr != Py_None && !file_is_closed(ferr)) {
Victor Stinner3466bde2016-09-05 18:16:01 -07001142 tmp = _PyObject_CallMethodId(ferr, &PyId_flush, NULL);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001143 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001144 PyErr_Clear();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001145 status = -1;
1146 }
Nick Coghland6009512014-11-20 21:39:37 +10001147 else
1148 Py_DECREF(tmp);
1149 }
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001150
1151 return status;
Nick Coghland6009512014-11-20 21:39:37 +10001152}
1153
1154/* Undo the effect of Py_Initialize().
1155
1156 Beware: if multiple interpreter and/or thread states exist, these
1157 are not wiped out; only the current thread and interpreter state
1158 are deleted. But since everything else is deleted, those other
1159 interpreter and thread states should no longer be used.
1160
1161 (XXX We should do better, e.g. wipe out all interpreters and
1162 threads.)
1163
1164 Locking: as above.
1165
1166*/
1167
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001168int
1169Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001170{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001171 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001172
Victor Stinner8e91c242019-04-24 17:24:01 +02001173 _PyRuntimeState *runtime = &_PyRuntime;
1174 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001175 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001176 }
Nick Coghland6009512014-11-20 21:39:37 +10001177
Eric Snow842a2f02019-03-15 15:47:51 -06001178 // Wrap up existing "threading"-module-created, non-daemon threads.
Nick Coghland6009512014-11-20 21:39:37 +10001179 wait_for_thread_shutdown();
1180
Eric Snow842a2f02019-03-15 15:47:51 -06001181 // Make any remaining pending calls.
Victor Stinnere225beb2019-06-03 18:14:24 +02001182 _Py_FinishPendingCalls(runtime);
1183
1184 /* Get current thread state and interpreter pointer */
1185 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
1186 PyInterpreterState *interp = tstate->interp;
Victor Stinner8e91c242019-04-24 17:24:01 +02001187
Nick Coghland6009512014-11-20 21:39:37 +10001188 /* The interpreter is still entirely intact at this point, and the
1189 * exit funcs may be relying on that. In particular, if some thread
1190 * or exit func is still waiting to do an import, the import machinery
1191 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001192 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001193 * Note that Threading.py uses an exit func to do a join on all the
1194 * threads created thru it, so this also protects pending imports in
1195 * the threads created via Threading.
1196 */
Nick Coghland6009512014-11-20 21:39:37 +10001197
Marcel Plch776407f2017-12-20 11:17:58 +01001198 call_py_exitfuncs(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001199
Victor Stinnerda273412017-12-15 01:46:02 +01001200 /* Copy the core config, PyInterpreterState_Delete() free
1201 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001202#ifdef Py_REF_DEBUG
Victor Stinner331a6a52019-05-27 16:39:22 +02001203 int show_ref_count = interp->config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001204#endif
1205#ifdef Py_TRACE_REFS
Victor Stinner331a6a52019-05-27 16:39:22 +02001206 int dump_refs = interp->config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001207#endif
1208#ifdef WITH_PYMALLOC
Victor Stinner331a6a52019-05-27 16:39:22 +02001209 int malloc_stats = interp->config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001210#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001211
Nick Coghland6009512014-11-20 21:39:37 +10001212 /* Remaining threads (e.g. daemon threads) will automatically exit
1213 after taking the GIL (in PyEval_RestoreThread()). */
Victor Stinner8e91c242019-04-24 17:24:01 +02001214 runtime->finalizing = tstate;
1215 runtime->initialized = 0;
1216 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001217
Victor Stinnere0deff32015-03-24 13:46:18 +01001218 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001219 if (flush_std_files() < 0) {
1220 status = -1;
1221 }
Nick Coghland6009512014-11-20 21:39:37 +10001222
1223 /* Disable signal handling */
1224 PyOS_FiniInterrupts();
1225
1226 /* Collect garbage. This may call finalizers; it's nice to call these
1227 * before all modules are destroyed.
1228 * XXX If a __del__ or weakref callback is triggered here, and tries to
1229 * XXX import a module, bad things can happen, because Python no
1230 * XXX longer believes it's initialized.
1231 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1232 * XXX is easy to provoke that way. I've also seen, e.g.,
1233 * XXX Exception exceptions.ImportError: 'No module named sha'
1234 * XXX in <function callback at 0x008F5718> ignored
1235 * XXX but I'm unclear on exactly how that one happens. In any case,
1236 * XXX I haven't seen a real-life report of either of these.
1237 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001238 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001239#ifdef COUNT_ALLOCS
1240 /* With COUNT_ALLOCS, it helps to run GC multiple times:
1241 each collection might release some types from the type
1242 list, so they become garbage. */
Łukasz Langafef7e942016-09-09 21:47:46 -07001243 while (_PyGC_CollectIfEnabled() > 0)
Nick Coghland6009512014-11-20 21:39:37 +10001244 /* nothing */;
1245#endif
Eric Snowdae02762017-09-14 00:35:58 -07001246
Steve Dowerb82e17e2019-05-23 08:45:22 -07001247 /* Clear all loghooks */
1248 /* We want minimal exposure of this function, so define the extern
1249 * here. The linker should discover the correct function without
1250 * exporting a symbol. */
1251 extern void _PySys_ClearAuditHooks(void);
1252 _PySys_ClearAuditHooks();
1253
Nick Coghland6009512014-11-20 21:39:37 +10001254 /* Destroy all modules */
1255 PyImport_Cleanup();
1256
Inada Naoki91234a12019-06-03 21:30:58 +09001257 /* Print debug stats if any */
1258 _PyEval_Fini();
1259
Victor Stinnere0deff32015-03-24 13:46:18 +01001260 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001261 if (flush_std_files() < 0) {
1262 status = -1;
1263 }
Nick Coghland6009512014-11-20 21:39:37 +10001264
1265 /* Collect final garbage. This disposes of cycles created by
1266 * class definitions, for example.
1267 * XXX This is disabled because it caused too many problems. If
1268 * XXX a __del__ or weakref callback triggers here, Python code has
1269 * XXX a hard time running, because even the sys module has been
1270 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1271 * XXX One symptom is a sequence of information-free messages
1272 * XXX coming from threads (if a __del__ or callback is invoked,
1273 * XXX other threads can execute too, and any exception they encounter
1274 * XXX triggers a comedy of errors as subsystem after subsystem
1275 * XXX fails to find what it *expects* to find in sys to help report
1276 * XXX the exception and consequent unexpected failures). I've also
1277 * XXX seen segfaults then, after adding print statements to the
1278 * XXX Python code getting called.
1279 */
1280#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001281 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001282#endif
1283
1284 /* Disable tracemalloc after all Python objects have been destroyed,
1285 so it is possible to use tracemalloc in objects destructor. */
1286 _PyTraceMalloc_Fini();
1287
1288 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1289 _PyImport_Fini();
1290
1291 /* Cleanup typeobject.c's internal caches. */
1292 _PyType_Fini();
1293
1294 /* unload faulthandler module */
1295 _PyFaulthandler_Fini();
1296
1297 /* Debugging stuff */
1298#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001299 _Py_dump_counts(stderr);
Nick Coghland6009512014-11-20 21:39:37 +10001300#endif
1301 /* dump hash stats */
1302 _PyHash_Fini();
1303
Eric Snowdae02762017-09-14 00:35:58 -07001304#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001305 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001306 _PyDebug_PrintTotalRefs();
1307 }
Eric Snowdae02762017-09-14 00:35:58 -07001308#endif
Nick Coghland6009512014-11-20 21:39:37 +10001309
1310#ifdef Py_TRACE_REFS
1311 /* Display all objects still alive -- this can invoke arbitrary
1312 * __repr__ overrides, so requires a mostly-intact interpreter.
1313 * Alas, a lot of stuff may still be alive now that will be cleaned
1314 * up later.
1315 */
Victor Stinnerda273412017-12-15 01:46:02 +01001316 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001317 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001318 }
Nick Coghland6009512014-11-20 21:39:37 +10001319#endif /* Py_TRACE_REFS */
1320
1321 /* Clear interpreter state and all thread states. */
1322 PyInterpreterState_Clear(interp);
1323
1324 /* Now we decref the exception classes. After this point nothing
1325 can raise an exception. That's okay, because each Fini() method
1326 below has been checked to make sure no exceptions are ever
1327 raised.
1328 */
1329
1330 _PyExc_Fini();
1331
1332 /* Sundry finalizers */
1333 PyMethod_Fini();
1334 PyFrame_Fini();
1335 PyCFunction_Fini();
1336 PyTuple_Fini();
1337 PyList_Fini();
1338 PySet_Fini();
1339 PyBytes_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001340 PyLong_Fini();
1341 PyFloat_Fini();
1342 PyDict_Fini();
1343 PySlice_Fini();
Victor Stinner8e91c242019-04-24 17:24:01 +02001344 _PyGC_Fini(runtime);
Eric Snow86ea5812019-05-10 13:29:55 -04001345 _PyWarnings_Fini(interp);
Eric Snow6b4be192017-05-22 21:36:03 -07001346 _Py_HashRandomization_Fini();
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001347 _PyArg_Fini();
Yury Selivanoveb636452016-09-08 22:01:51 -07001348 PyAsyncGen_Fini();
Yury Selivanovf23746a2018-01-22 19:11:18 -05001349 _PyContext_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001350
1351 /* Cleanup Unicode implementation */
1352 _PyUnicode_Fini();
1353
Victor Stinnerb2457ef2018-08-29 13:25:36 +02001354 _Py_ClearFileSystemEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10001355
1356 /* XXX Still allocated:
1357 - various static ad-hoc pointers to interned strings
1358 - int and float free list blocks
1359 - whatever various modules and libraries allocate
1360 */
1361
1362 PyGrammar_RemoveAccelerators(&_PyParser_Grammar);
1363
1364 /* Cleanup auto-thread-state */
Victor Stinner8e91c242019-04-24 17:24:01 +02001365 _PyGILState_Fini(runtime);
Nick Coghland6009512014-11-20 21:39:37 +10001366
1367 /* Delete current thread. After this, many C API calls become crashy. */
1368 PyThreadState_Swap(NULL);
Victor Stinner8a1be612016-03-14 22:07:55 +01001369
Nick Coghland6009512014-11-20 21:39:37 +10001370 PyInterpreterState_Delete(interp);
1371
1372#ifdef Py_TRACE_REFS
1373 /* Display addresses (& refcnts) of all objects still alive.
1374 * An address can be used to find the repr of the object, printed
1375 * above by _Py_PrintReferences.
1376 */
Victor Stinnerda273412017-12-15 01:46:02 +01001377 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001378 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001379 }
Nick Coghland6009512014-11-20 21:39:37 +10001380#endif /* Py_TRACE_REFS */
Victor Stinner34be8072016-03-14 12:04:26 +01001381#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001382 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001383 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be8072016-03-14 12:04:26 +01001384 }
Nick Coghland6009512014-11-20 21:39:37 +10001385#endif
1386
Victor Stinner8e91c242019-04-24 17:24:01 +02001387 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001388
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001389 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001390 return status;
1391}
1392
1393void
1394Py_Finalize(void)
1395{
1396 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001397}
1398
1399/* Create and initialize a new interpreter and thread, and return the
1400 new thread. This requires that Py_Initialize() has been called
1401 first.
1402
1403 Unsuccessful initialization yields a NULL pointer. Note that *no*
1404 exception information is available even in this case -- the
1405 exception information is held in the thread, and there is no
1406 thread.
1407
1408 Locking: as above.
1409
1410*/
1411
Victor Stinner331a6a52019-05-27 16:39:22 +02001412static PyStatus
Victor Stinnera7368ac2017-11-15 18:11:45 -08001413new_interpreter(PyThreadState **tstate_p)
Nick Coghland6009512014-11-20 21:39:37 +10001414{
Victor Stinner331a6a52019-05-27 16:39:22 +02001415 PyStatus status;
Nick Coghland6009512014-11-20 21:39:37 +10001416
Victor Stinner331a6a52019-05-27 16:39:22 +02001417 status = _PyRuntime_Initialize();
1418 if (_PyStatus_EXCEPTION(status)) {
1419 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001420 }
1421 _PyRuntimeState *runtime = &_PyRuntime;
1422
1423 if (!runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001424 return _PyStatus_ERR("Py_Initialize must be called first");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001425 }
Nick Coghland6009512014-11-20 21:39:37 +10001426
Victor Stinner8a1be612016-03-14 22:07:55 +01001427 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1428 interpreters: disable PyGILState_Check(). */
1429 _PyGILState_check_enabled = 0;
1430
Victor Stinner43125222019-04-24 18:23:53 +02001431 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001432 if (interp == NULL) {
1433 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001434 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001435 }
Nick Coghland6009512014-11-20 21:39:37 +10001436
Victor Stinner43125222019-04-24 18:23:53 +02001437 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001438 if (tstate == NULL) {
1439 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001440 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001441 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001442 }
1443
Victor Stinner43125222019-04-24 18:23:53 +02001444 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001445
Eric Snow1abcf672017-05-23 21:46:51 -07001446 /* Copy the current interpreter config into the new interpreter */
Victor Stinner331a6a52019-05-27 16:39:22 +02001447 PyConfig *config;
Eric Snow1abcf672017-05-23 21:46:51 -07001448 if (save_tstate != NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001449 config = &save_tstate->interp->config;
Eric Snow1abcf672017-05-23 21:46:51 -07001450 } else {
1451 /* No current thread state, copy from the main interpreter */
1452 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinner331a6a52019-05-27 16:39:22 +02001453 config = &main_interp->config;
Victor Stinnerda273412017-12-15 01:46:02 +01001454 }
1455
Victor Stinner331a6a52019-05-27 16:39:22 +02001456 status = _PyConfig_Copy(&interp->config, config);
1457 if (_PyStatus_EXCEPTION(status)) {
1458 return status;
Victor Stinnerda273412017-12-15 01:46:02 +01001459 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001460 config = &interp->config;
Eric Snow1abcf672017-05-23 21:46:51 -07001461
Victor Stinner331a6a52019-05-27 16:39:22 +02001462 status = _PyExc_Init();
1463 if (_PyStatus_EXCEPTION(status)) {
1464 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001465 }
1466
Victor Stinner331a6a52019-05-27 16:39:22 +02001467 status = _PyErr_Init();
1468 if (_PyStatus_EXCEPTION(status)) {
1469 return status;
Victor Stinneref9d9b62019-05-22 11:28:22 +02001470 }
1471
1472
Nick Coghland6009512014-11-20 21:39:37 +10001473 /* XXX The following is lax in error checking */
Eric Snowd393c1b2017-09-14 12:18:12 -06001474 PyObject *modules = PyDict_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001475 if (modules == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001476 return _PyStatus_ERR("can't make modules dictionary");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001477 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001478 interp->modules = modules;
Nick Coghland6009512014-11-20 21:39:37 +10001479
Victor Stinner43125222019-04-24 18:23:53 +02001480 PyObject *sysmod = _PyImport_FindBuiltin("sys", modules);
Eric Snowd393c1b2017-09-14 12:18:12 -06001481 if (sysmod != NULL) {
1482 interp->sysdict = PyModule_GetDict(sysmod);
Victor Stinner43125222019-04-24 18:23:53 +02001483 if (interp->sysdict == NULL) {
Eric Snowd393c1b2017-09-14 12:18:12 -06001484 goto handle_error;
Victor Stinner43125222019-04-24 18:23:53 +02001485 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001486 Py_INCREF(interp->sysdict);
1487 PyDict_SetItemString(interp->sysdict, "modules", modules);
Victor Stinner0fd2c302019-06-04 03:15:09 +02001488 if (_PySys_InitMain(runtime, interp) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001489 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerab672812019-01-23 15:04:40 +01001490 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001491 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001492 else if (PyErr_Occurred()) {
1493 goto handle_error;
1494 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001495
Victor Stinner43125222019-04-24 18:23:53 +02001496 PyObject *bimod = _PyImport_FindBuiltin("builtins", modules);
Nick Coghland6009512014-11-20 21:39:37 +10001497 if (bimod != NULL) {
1498 interp->builtins = PyModule_GetDict(bimod);
1499 if (interp->builtins == NULL)
1500 goto handle_error;
1501 Py_INCREF(interp->builtins);
1502 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001503 else if (PyErr_Occurred()) {
1504 goto handle_error;
1505 }
Nick Coghland6009512014-11-20 21:39:37 +10001506
Nick Coghland6009512014-11-20 21:39:37 +10001507 if (bimod != NULL && sysmod != NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001508 status = _PyBuiltins_AddExceptions(bimod);
1509 if (_PyStatus_EXCEPTION(status)) {
1510 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001511 }
Nick Coghland6009512014-11-20 21:39:37 +10001512
Victor Stinner331a6a52019-05-27 16:39:22 +02001513 status = _PySys_SetPreliminaryStderr(interp->sysdict);
1514 if (_PyStatus_EXCEPTION(status)) {
1515 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001516 }
Nick Coghland6009512014-11-20 21:39:37 +10001517
Victor Stinner331a6a52019-05-27 16:39:22 +02001518 status = _PyImportHooks_Init();
1519 if (_PyStatus_EXCEPTION(status)) {
1520 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001521 }
Nick Coghland6009512014-11-20 21:39:37 +10001522
Victor Stinner331a6a52019-05-27 16:39:22 +02001523 status = init_importlib(interp, sysmod);
1524 if (_PyStatus_EXCEPTION(status)) {
1525 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001526 }
Nick Coghland6009512014-11-20 21:39:37 +10001527
Victor Stinner331a6a52019-05-27 16:39:22 +02001528 status = init_importlib_external(interp);
1529 if (_PyStatus_EXCEPTION(status)) {
1530 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001531 }
Nick Coghland6009512014-11-20 21:39:37 +10001532
Victor Stinnerc5c64252019-09-23 15:59:00 +02001533 status = _PyUnicode_InitEncodings(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001534 if (_PyStatus_EXCEPTION(status)) {
1535 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001536 }
1537
Victor Stinner331a6a52019-05-27 16:39:22 +02001538 status = init_sys_streams(interp);
1539 if (_PyStatus_EXCEPTION(status)) {
1540 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001541 }
1542
Victor Stinner331a6a52019-05-27 16:39:22 +02001543 status = add_main_module(interp);
1544 if (_PyStatus_EXCEPTION(status)) {
1545 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001546 }
1547
Victor Stinner331a6a52019-05-27 16:39:22 +02001548 if (config->site_import) {
1549 status = init_import_size();
1550 if (_PyStatus_EXCEPTION(status)) {
1551 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001552 }
1553 }
Nick Coghland6009512014-11-20 21:39:37 +10001554 }
1555
Victor Stinnera7368ac2017-11-15 18:11:45 -08001556 if (PyErr_Occurred()) {
1557 goto handle_error;
1558 }
Nick Coghland6009512014-11-20 21:39:37 +10001559
Victor Stinnera7368ac2017-11-15 18:11:45 -08001560 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +02001561 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001562
Nick Coghland6009512014-11-20 21:39:37 +10001563handle_error:
1564 /* Oops, it didn't work. Undo it all. */
1565
1566 PyErr_PrintEx(0);
1567 PyThreadState_Clear(tstate);
1568 PyThreadState_Swap(save_tstate);
1569 PyThreadState_Delete(tstate);
1570 PyInterpreterState_Delete(interp);
1571
Victor Stinnera7368ac2017-11-15 18:11:45 -08001572 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001573 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001574}
1575
1576PyThreadState *
1577Py_NewInterpreter(void)
1578{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001579 PyThreadState *tstate = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001580 PyStatus status = new_interpreter(&tstate);
1581 if (_PyStatus_EXCEPTION(status)) {
1582 Py_ExitStatusException(status);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001583 }
1584 return tstate;
1585
Nick Coghland6009512014-11-20 21:39:37 +10001586}
1587
1588/* Delete an interpreter and its last thread. This requires that the
1589 given thread state is current, that the thread has no remaining
1590 frames, and that it is its interpreter's only remaining thread.
1591 It is a fatal error to violate these constraints.
1592
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001593 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001594 everything, regardless.)
1595
1596 Locking: as above.
1597
1598*/
1599
1600void
1601Py_EndInterpreter(PyThreadState *tstate)
1602{
1603 PyInterpreterState *interp = tstate->interp;
1604
Victor Stinner50b48572018-11-01 01:51:40 +01001605 if (tstate != _PyThreadState_GET())
Nick Coghland6009512014-11-20 21:39:37 +10001606 Py_FatalError("Py_EndInterpreter: thread is not current");
1607 if (tstate->frame != NULL)
1608 Py_FatalError("Py_EndInterpreter: thread still has a frame");
Eric Snow5be45a62019-03-08 22:47:07 -07001609 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001610
Eric Snow842a2f02019-03-15 15:47:51 -06001611 // Wrap up existing "threading"-module-created, non-daemon threads.
Nick Coghland6009512014-11-20 21:39:37 +10001612 wait_for_thread_shutdown();
1613
Marcel Plch776407f2017-12-20 11:17:58 +01001614 call_py_exitfuncs(interp);
1615
Nick Coghland6009512014-11-20 21:39:37 +10001616 if (tstate != interp->tstate_head || tstate->next != NULL)
1617 Py_FatalError("Py_EndInterpreter: not the last thread");
1618
1619 PyImport_Cleanup();
1620 PyInterpreterState_Clear(interp);
1621 PyThreadState_Swap(NULL);
1622 PyInterpreterState_Delete(interp);
1623}
1624
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001625/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001626
Victor Stinner331a6a52019-05-27 16:39:22 +02001627static PyStatus
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001628add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001629{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001630 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001631 m = PyImport_AddModule("__main__");
1632 if (m == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +02001633 return _PyStatus_ERR("can't create __main__ module");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001634
Nick Coghland6009512014-11-20 21:39:37 +10001635 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001636 ann_dict = PyDict_New();
1637 if ((ann_dict == NULL) ||
1638 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001639 return _PyStatus_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001640 }
1641 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001642
Nick Coghland6009512014-11-20 21:39:37 +10001643 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1644 PyObject *bimod = PyImport_ImportModule("builtins");
1645 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001646 return _PyStatus_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001647 }
1648 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001649 return _PyStatus_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001650 }
1651 Py_DECREF(bimod);
1652 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001653
Nick Coghland6009512014-11-20 21:39:37 +10001654 /* Main is a little special - imp.is_builtin("__main__") will return
1655 * False, but BuiltinImporter is still the most appropriate initial
1656 * setting for its __loader__ attribute. A more suitable value will
1657 * be set if __main__ gets further initialized later in the startup
1658 * process.
1659 */
1660 loader = PyDict_GetItemString(d, "__loader__");
1661 if (loader == NULL || loader == Py_None) {
1662 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1663 "BuiltinImporter");
1664 if (loader == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001665 return _PyStatus_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001666 }
1667 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001668 return _PyStatus_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001669 }
1670 Py_DECREF(loader);
1671 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001672 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001673}
1674
Nick Coghland6009512014-11-20 21:39:37 +10001675/* Import the site module (not into __main__ though) */
1676
Victor Stinner331a6a52019-05-27 16:39:22 +02001677static PyStatus
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001678init_import_size(void)
Nick Coghland6009512014-11-20 21:39:37 +10001679{
1680 PyObject *m;
1681 m = PyImport_ImportModule("site");
1682 if (m == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001683 return _PyStatus_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001684 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001685 Py_DECREF(m);
Victor Stinner331a6a52019-05-27 16:39:22 +02001686 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001687}
1688
Victor Stinner874dbe82015-09-04 17:29:57 +02001689/* Check if a file descriptor is valid or not.
1690 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1691static int
1692is_valid_fd(int fd)
1693{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001694/* dup() is faster than fstat(): fstat() can require input/output operations,
1695 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1696 startup. Problem: dup() doesn't check if the file descriptor is valid on
1697 some platforms.
1698
1699 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1700 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1701 EBADF. FreeBSD has similar issue (bpo-32849).
1702
1703 Only use dup() on platforms where dup() is enough to detect invalid FD in
1704 corner cases: on Linux and Windows (bpo-32849). */
1705#if defined(__linux__) || defined(MS_WINDOWS)
1706 if (fd < 0) {
1707 return 0;
1708 }
1709 int fd2;
1710
1711 _Py_BEGIN_SUPPRESS_IPH
1712 fd2 = dup(fd);
1713 if (fd2 >= 0) {
1714 close(fd2);
1715 }
1716 _Py_END_SUPPRESS_IPH
1717
1718 return (fd2 >= 0);
1719#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001720 struct stat st;
1721 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001722#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001723}
1724
1725/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001726static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02001727create_stdio(const PyConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001728 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001729 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001730{
1731 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1732 const char* mode;
1733 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001734 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001735 int buffering, isatty;
1736 _Py_IDENTIFIER(open);
1737 _Py_IDENTIFIER(isatty);
1738 _Py_IDENTIFIER(TextIOWrapper);
1739 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001740 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001741
Victor Stinner874dbe82015-09-04 17:29:57 +02001742 if (!is_valid_fd(fd))
1743 Py_RETURN_NONE;
1744
Nick Coghland6009512014-11-20 21:39:37 +10001745 /* stdin is always opened in buffered mode, first because it shouldn't
1746 make a difference in common use cases, second because TextIOWrapper
1747 depends on the presence of a read1() method which only exists on
1748 buffered streams.
1749 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001750 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001751 buffering = 0;
1752 else
1753 buffering = -1;
1754 if (write_mode)
1755 mode = "wb";
1756 else
1757 mode = "rb";
1758 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOi",
1759 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001760 Py_None, Py_None, /* encoding, errors */
1761 Py_None, 0); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001762 if (buf == NULL)
1763 goto error;
1764
1765 if (buffering) {
1766 _Py_IDENTIFIER(raw);
1767 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1768 if (raw == NULL)
1769 goto error;
1770 }
1771 else {
1772 raw = buf;
1773 Py_INCREF(raw);
1774 }
1775
Steve Dower39294992016-08-30 21:22:36 -07001776#ifdef MS_WINDOWS
1777 /* Windows console IO is always UTF-8 encoded */
1778 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001779 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001780#endif
1781
Nick Coghland6009512014-11-20 21:39:37 +10001782 text = PyUnicode_FromString(name);
1783 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1784 goto error;
Victor Stinner3466bde2016-09-05 18:16:01 -07001785 res = _PyObject_CallMethodId(raw, &PyId_isatty, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10001786 if (res == NULL)
1787 goto error;
1788 isatty = PyObject_IsTrue(res);
1789 Py_DECREF(res);
1790 if (isatty == -1)
1791 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001792 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001793 write_through = Py_True;
1794 else
1795 write_through = Py_False;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001796 if (isatty && buffered_stdio)
Nick Coghland6009512014-11-20 21:39:37 +10001797 line_buffering = Py_True;
1798 else
1799 line_buffering = Py_False;
1800
1801 Py_CLEAR(raw);
1802 Py_CLEAR(text);
1803
1804#ifdef MS_WINDOWS
1805 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1806 newlines to "\n".
1807 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1808 newline = NULL;
1809#else
1810 /* sys.stdin: split lines at "\n".
1811 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1812 newline = "\n";
1813#endif
1814
Victor Stinner709d23d2019-05-02 14:56:30 -04001815 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1816 if (encoding_str == NULL) {
1817 Py_CLEAR(buf);
1818 goto error;
1819 }
1820
1821 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1822 if (errors_str == NULL) {
1823 Py_CLEAR(buf);
1824 Py_CLEAR(encoding_str);
1825 goto error;
1826 }
1827
1828 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1829 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001830 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001831 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001832 Py_CLEAR(encoding_str);
1833 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001834 if (stream == NULL)
1835 goto error;
1836
1837 if (write_mode)
1838 mode = "w";
1839 else
1840 mode = "r";
1841 text = PyUnicode_FromString(mode);
1842 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1843 goto error;
1844 Py_CLEAR(text);
1845 return stream;
1846
1847error:
1848 Py_XDECREF(buf);
1849 Py_XDECREF(stream);
1850 Py_XDECREF(text);
1851 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001852
Victor Stinner874dbe82015-09-04 17:29:57 +02001853 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1854 /* Issue #24891: the file descriptor was closed after the first
1855 is_valid_fd() check was called. Ignore the OSError and set the
1856 stream to None. */
1857 PyErr_Clear();
1858 Py_RETURN_NONE;
1859 }
1860 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001861}
1862
1863/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinner331a6a52019-05-27 16:39:22 +02001864static PyStatus
Victor Stinner91106cd2017-12-13 12:29:09 +01001865init_sys_streams(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001866{
1867 PyObject *iomod = NULL, *wrapper;
1868 PyObject *bimod = NULL;
1869 PyObject *m;
1870 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001871 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001872 PyObject * encoding_attr;
Victor Stinner331a6a52019-05-27 16:39:22 +02001873 PyStatus res = _PyStatus_OK();
1874 PyConfig *config = &interp->config;
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001875
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001876 /* Check that stdin is not a directory
1877 Using shell redirection, you can redirect stdin to a directory,
1878 crashing the Python interpreter. Catch this common mistake here
1879 and output a useful error message. Note that under MS Windows,
1880 the shell already prevents that. */
1881#ifndef MS_WINDOWS
1882 struct _Py_stat_struct sb;
1883 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1884 S_ISDIR(sb.st_mode)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001885 return _PyStatus_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001886 }
1887#endif
1888
Nick Coghland6009512014-11-20 21:39:37 +10001889 /* Hack to avoid a nasty recursion issue when Python is invoked
1890 in verbose mode: pre-import the Latin-1 and UTF-8 codecs */
1891 if ((m = PyImport_ImportModule("encodings.utf_8")) == NULL) {
1892 goto error;
1893 }
1894 Py_DECREF(m);
1895
1896 if (!(m = PyImport_ImportModule("encodings.latin_1"))) {
1897 goto error;
1898 }
1899 Py_DECREF(m);
1900
1901 if (!(bimod = PyImport_ImportModule("builtins"))) {
1902 goto error;
1903 }
1904
1905 if (!(iomod = PyImport_ImportModule("io"))) {
1906 goto error;
1907 }
1908 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1909 goto error;
1910 }
1911
1912 /* Set builtins.open */
1913 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1914 Py_DECREF(wrapper);
1915 goto error;
1916 }
1917 Py_DECREF(wrapper);
1918
Nick Coghland6009512014-11-20 21:39:37 +10001919 /* Set sys.stdin */
1920 fd = fileno(stdin);
1921 /* Under some conditions stdin, stdout and stderr may not be connected
1922 * and fileno() may point to an invalid file descriptor. For example
1923 * GUI apps don't have valid standard streams by default.
1924 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001925 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001926 config->stdio_encoding,
1927 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001928 if (std == NULL)
1929 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001930 PySys_SetObject("__stdin__", std);
1931 _PySys_SetObjectId(&PyId_stdin, std);
1932 Py_DECREF(std);
1933
1934 /* Set sys.stdout */
1935 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001936 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001937 config->stdio_encoding,
1938 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001939 if (std == NULL)
1940 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001941 PySys_SetObject("__stdout__", std);
1942 _PySys_SetObjectId(&PyId_stdout, std);
1943 Py_DECREF(std);
1944
1945#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
1946 /* Set sys.stderr, replaces the preliminary stderr */
1947 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001948 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001949 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04001950 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02001951 if (std == NULL)
1952 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001953
1954 /* Same as hack above, pre-import stderr's codec to avoid recursion
1955 when import.c tries to write to stderr in verbose mode. */
1956 encoding_attr = PyObject_GetAttrString(std, "encoding");
1957 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001958 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10001959 if (std_encoding != NULL) {
1960 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
1961 Py_XDECREF(codec_info);
1962 }
1963 Py_DECREF(encoding_attr);
1964 }
1965 PyErr_Clear(); /* Not a fatal error if codec isn't available */
1966
1967 if (PySys_SetObject("__stderr__", std) < 0) {
1968 Py_DECREF(std);
1969 goto error;
1970 }
1971 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
1972 Py_DECREF(std);
1973 goto error;
1974 }
1975 Py_DECREF(std);
1976#endif
1977
Victor Stinnera7368ac2017-11-15 18:11:45 -08001978 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10001979
Victor Stinnera7368ac2017-11-15 18:11:45 -08001980error:
Victor Stinner331a6a52019-05-27 16:39:22 +02001981 res = _PyStatus_ERR("can't initialize sys standard streams");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001982
1983done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02001984 _Py_ClearStandardStreamEncoding();
Victor Stinner31e99082017-12-20 23:41:38 +01001985
Nick Coghland6009512014-11-20 21:39:37 +10001986 Py_XDECREF(bimod);
1987 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001988 return res;
Nick Coghland6009512014-11-20 21:39:37 +10001989}
1990
1991
Victor Stinner10dc4842015-03-24 12:01:30 +01001992static void
Victor Stinner47bbab92019-09-18 14:10:16 +02001993_Py_FatalError_DumpTracebacks(int fd, PyInterpreterState *interp,
1994 PyThreadState *tstate)
Victor Stinner10dc4842015-03-24 12:01:30 +01001995{
Victor Stinner10dc4842015-03-24 12:01:30 +01001996 fputc('\n', stderr);
1997 fflush(stderr);
1998
1999 /* display the current Python stack */
Victor Stinner47bbab92019-09-18 14:10:16 +02002000 _Py_DumpTracebackThreads(fd, interp, tstate);
Victor Stinner10dc4842015-03-24 12:01:30 +01002001}
Victor Stinner791da1c2016-03-14 16:53:12 +01002002
2003/* Print the current exception (if an exception is set) with its traceback,
2004 or display the current Python stack.
2005
2006 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
2007 called on catastrophic cases.
2008
2009 Return 1 if the traceback was displayed, 0 otherwise. */
2010
2011static int
2012_Py_FatalError_PrintExc(int fd)
2013{
2014 PyObject *ferr, *res;
2015 PyObject *exception, *v, *tb;
2016 int has_tb;
2017
Victor Stinner791da1c2016-03-14 16:53:12 +01002018 PyErr_Fetch(&exception, &v, &tb);
2019 if (exception == NULL) {
2020 /* No current exception */
2021 return 0;
2022 }
2023
2024 ferr = _PySys_GetObjectId(&PyId_stderr);
2025 if (ferr == NULL || ferr == Py_None) {
2026 /* sys.stderr is not set yet or set to None,
2027 no need to try to display the exception */
2028 return 0;
2029 }
2030
2031 PyErr_NormalizeException(&exception, &v, &tb);
2032 if (tb == NULL) {
2033 tb = Py_None;
2034 Py_INCREF(tb);
2035 }
2036 PyException_SetTraceback(v, tb);
2037 if (exception == NULL) {
2038 /* PyErr_NormalizeException() failed */
2039 return 0;
2040 }
2041
2042 has_tb = (tb != Py_None);
2043 PyErr_Display(exception, v, tb);
2044 Py_XDECREF(exception);
2045 Py_XDECREF(v);
2046 Py_XDECREF(tb);
2047
2048 /* sys.stderr may be buffered: call sys.stderr.flush() */
Victor Stinner3466bde2016-09-05 18:16:01 -07002049 res = _PyObject_CallMethodId(ferr, &PyId_flush, NULL);
Victor Stinner791da1c2016-03-14 16:53:12 +01002050 if (res == NULL)
2051 PyErr_Clear();
2052 else
2053 Py_DECREF(res);
2054
2055 return has_tb;
2056}
2057
Nick Coghland6009512014-11-20 21:39:37 +10002058/* Print fatal error message and abort */
2059
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002060#ifdef MS_WINDOWS
2061static void
2062fatal_output_debug(const char *msg)
2063{
2064 /* buffer of 256 bytes allocated on the stack */
2065 WCHAR buffer[256 / sizeof(WCHAR)];
2066 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2067 size_t msglen;
2068
2069 OutputDebugStringW(L"Fatal Python error: ");
2070
2071 msglen = strlen(msg);
2072 while (msglen) {
2073 size_t i;
2074
2075 if (buflen > msglen) {
2076 buflen = msglen;
2077 }
2078
2079 /* Convert the message to wchar_t. This uses a simple one-to-one
2080 conversion, assuming that the this error message actually uses
2081 ASCII only. If this ceases to be true, we will have to convert. */
2082 for (i=0; i < buflen; ++i) {
2083 buffer[i] = msg[i];
2084 }
2085 buffer[i] = L'\0';
2086 OutputDebugStringW(buffer);
2087
2088 msg += buflen;
2089 msglen -= buflen;
2090 }
2091 OutputDebugStringW(L"\n");
2092}
2093#endif
2094
Victor Stinner47bbab92019-09-18 14:10:16 +02002095
2096static void
2097fatal_error_dump_runtime(FILE *stream, _PyRuntimeState *runtime)
2098{
2099 fprintf(stream, "Python runtime state: ");
2100 if (runtime->finalizing) {
2101 fprintf(stream, "finalizing (tstate=%p)", runtime->finalizing);
2102 }
2103 else if (runtime->initialized) {
2104 fprintf(stream, "initialized");
2105 }
2106 else if (runtime->core_initialized) {
2107 fprintf(stream, "core initialized");
2108 }
2109 else if (runtime->preinitialized) {
2110 fprintf(stream, "preinitialized");
2111 }
2112 else if (runtime->preinitializing) {
2113 fprintf(stream, "preinitializing");
2114 }
2115 else {
2116 fprintf(stream, "unknown");
2117 }
2118 fprintf(stream, "\n");
2119 fflush(stream);
2120}
2121
2122
Benjamin Petersoncef88b92017-11-25 13:02:55 -08002123static void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002124fatal_error(const char *prefix, const char *msg, int status)
Nick Coghland6009512014-11-20 21:39:37 +10002125{
Victor Stinner47bbab92019-09-18 14:10:16 +02002126 FILE *stream = stderr;
2127 const int fd = fileno(stream);
Victor Stinner53345a42015-03-25 01:55:14 +01002128 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002129
2130 if (reentrant) {
2131 /* Py_FatalError() caused a second fatal error.
2132 Example: flush_std_files() raises a recursion error. */
2133 goto exit;
2134 }
2135 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002136
Victor Stinner47bbab92019-09-18 14:10:16 +02002137 fprintf(stream, "Fatal Python error: ");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002138 if (prefix) {
Victor Stinner47bbab92019-09-18 14:10:16 +02002139 fputs(prefix, stream);
2140 fputs(": ", stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002141 }
2142 if (msg) {
Victor Stinner47bbab92019-09-18 14:10:16 +02002143 fputs(msg, stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002144 }
2145 else {
Victor Stinner47bbab92019-09-18 14:10:16 +02002146 fprintf(stream, "<message not set>");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002147 }
Victor Stinner47bbab92019-09-18 14:10:16 +02002148 fputs("\n", stream);
2149 fflush(stream); /* it helps in Windows debug build */
2150
2151 _PyRuntimeState *runtime = &_PyRuntime;
2152 fatal_error_dump_runtime(stream, runtime);
2153
2154 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
2155 PyInterpreterState *interp = NULL;
2156 if (tstate != NULL) {
2157 interp = tstate->interp;
2158 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002159
Victor Stinner3a228ab2018-11-01 00:26:41 +01002160 /* Check if the current thread has a Python thread state
Victor Stinner47bbab92019-09-18 14:10:16 +02002161 and holds the GIL.
Victor Stinner3a228ab2018-11-01 00:26:41 +01002162
Victor Stinner47bbab92019-09-18 14:10:16 +02002163 tss_tstate is NULL if Py_FatalError() is called from a C thread which
2164 has no Python thread state.
2165
2166 tss_tstate != tstate if the current Python thread does not hold the GIL.
2167 */
2168 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2169 int has_tstate_and_gil = (tss_tstate != NULL && tss_tstate == tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002170 if (has_tstate_and_gil) {
2171 /* If an exception is set, print the exception with its traceback */
2172 if (!_Py_FatalError_PrintExc(fd)) {
2173 /* No exception is set, or an exception is set without traceback */
Victor Stinner47bbab92019-09-18 14:10:16 +02002174 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002175 }
2176 }
2177 else {
Victor Stinner47bbab92019-09-18 14:10:16 +02002178 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002179 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002180
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002181 /* The main purpose of faulthandler is to display the traceback.
2182 This function already did its best to display a traceback.
2183 Disable faulthandler to prevent writing a second traceback
2184 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002185 _PyFaulthandler_Fini();
2186
Victor Stinner791da1c2016-03-14 16:53:12 +01002187 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002188 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002189 /* Flush sys.stdout and sys.stderr */
2190 flush_std_files();
2191 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002192
Nick Coghland6009512014-11-20 21:39:37 +10002193#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002194 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002195#endif /* MS_WINDOWS */
2196
2197exit:
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002198 if (status < 0) {
Victor Stinner53345a42015-03-25 01:55:14 +01002199#if defined(MS_WINDOWS) && defined(_DEBUG)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002200 DebugBreak();
Nick Coghland6009512014-11-20 21:39:37 +10002201#endif
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002202 abort();
2203 }
2204 else {
2205 exit(status);
2206 }
2207}
2208
Victor Stinner19760862017-12-20 01:41:59 +01002209void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002210Py_FatalError(const char *msg)
2211{
2212 fatal_error(NULL, msg, -1);
2213}
2214
Victor Stinner19760862017-12-20 01:41:59 +01002215void _Py_NO_RETURN
Victor Stinner331a6a52019-05-27 16:39:22 +02002216Py_ExitStatusException(PyStatus status)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002217{
Victor Stinner331a6a52019-05-27 16:39:22 +02002218 if (_PyStatus_IS_EXIT(status)) {
2219 exit(status.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002220 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002221 else if (_PyStatus_IS_ERROR(status)) {
2222 fatal_error(status.func, status.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002223 }
2224 else {
Victor Stinner331a6a52019-05-27 16:39:22 +02002225 Py_FatalError("Py_ExitStatusException() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002226 }
Nick Coghland6009512014-11-20 21:39:37 +10002227}
2228
2229/* Clean up and exit */
2230
Victor Stinnerd7292b52016-06-17 12:29:00 +02002231# include "pythread.h"
Nick Coghland6009512014-11-20 21:39:37 +10002232
Nick Coghland6009512014-11-20 21:39:37 +10002233/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002234void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002235{
Victor Stinnercaba55b2018-08-03 15:33:52 +02002236 PyInterpreterState *is = _PyInterpreterState_Get();
Marcel Plch776407f2017-12-20 11:17:58 +01002237
Antoine Pitroufc5db952017-12-13 02:29:07 +01002238 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002239 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2240
2241 is->pyexitfunc = func;
2242 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002243}
2244
2245static void
Marcel Plch776407f2017-12-20 11:17:58 +01002246call_py_exitfuncs(PyInterpreterState *istate)
Nick Coghland6009512014-11-20 21:39:37 +10002247{
Marcel Plch776407f2017-12-20 11:17:58 +01002248 if (istate->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002249 return;
2250
Marcel Plch776407f2017-12-20 11:17:58 +01002251 (*istate->pyexitfunc)(istate->pyexitmodule);
Nick Coghland6009512014-11-20 21:39:37 +10002252 PyErr_Clear();
2253}
2254
2255/* Wait until threading._shutdown completes, provided
2256 the threading module was imported in the first place.
2257 The shutdown routine will wait until all non-daemon
2258 "threading" threads have completed. */
2259static void
2260wait_for_thread_shutdown(void)
2261{
Nick Coghland6009512014-11-20 21:39:37 +10002262 _Py_IDENTIFIER(_shutdown);
2263 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002264 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002265 if (threading == NULL) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002266 if (PyErr_Occurred()) {
2267 PyErr_WriteUnraisable(NULL);
2268 }
2269 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002270 return;
2271 }
Victor Stinner3466bde2016-09-05 18:16:01 -07002272 result = _PyObject_CallMethodId(threading, &PyId__shutdown, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10002273 if (result == NULL) {
2274 PyErr_WriteUnraisable(threading);
2275 }
2276 else {
2277 Py_DECREF(result);
2278 }
2279 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002280}
2281
2282#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002283int Py_AtExit(void (*func)(void))
2284{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002285 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002286 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002287 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002288 return 0;
2289}
2290
2291static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002292call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002293{
Victor Stinner8e91c242019-04-24 17:24:01 +02002294 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002295 /* pop last function from the list */
2296 runtime->nexitfuncs--;
2297 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2298 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2299
2300 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002301 }
Nick Coghland6009512014-11-20 21:39:37 +10002302
2303 fflush(stdout);
2304 fflush(stderr);
2305}
2306
Victor Stinnercfc88312018-08-01 16:41:25 +02002307void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002308Py_Exit(int sts)
2309{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002310 if (Py_FinalizeEx() < 0) {
2311 sts = 120;
2312 }
Nick Coghland6009512014-11-20 21:39:37 +10002313
2314 exit(sts);
2315}
2316
Victor Stinner331a6a52019-05-27 16:39:22 +02002317static PyStatus
Victor Stinner43fc3bb2019-05-02 11:54:20 -04002318init_signals(void)
Nick Coghland6009512014-11-20 21:39:37 +10002319{
2320#ifdef SIGPIPE
2321 PyOS_setsig(SIGPIPE, SIG_IGN);
2322#endif
2323#ifdef SIGXFZ
2324 PyOS_setsig(SIGXFZ, SIG_IGN);
2325#endif
2326#ifdef SIGXFSZ
2327 PyOS_setsig(SIGXFSZ, SIG_IGN);
2328#endif
2329 PyOS_InitInterrupts(); /* May imply initsignal() */
2330 if (PyErr_Occurred()) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002331 return _PyStatus_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002332 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002333 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002334}
2335
2336
2337/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2338 *
2339 * All of the code in this function must only use async-signal-safe functions,
2340 * listed at `man 7 signal` or
2341 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2342 */
2343void
2344_Py_RestoreSignals(void)
2345{
2346#ifdef SIGPIPE
2347 PyOS_setsig(SIGPIPE, SIG_DFL);
2348#endif
2349#ifdef SIGXFZ
2350 PyOS_setsig(SIGXFZ, SIG_DFL);
2351#endif
2352#ifdef SIGXFSZ
2353 PyOS_setsig(SIGXFSZ, SIG_DFL);
2354#endif
2355}
2356
2357
2358/*
2359 * The file descriptor fd is considered ``interactive'' if either
2360 * a) isatty(fd) is TRUE, or
2361 * b) the -i flag was given, and the filename associated with
2362 * the descriptor is NULL or "<stdin>" or "???".
2363 */
2364int
2365Py_FdIsInteractive(FILE *fp, const char *filename)
2366{
2367 if (isatty((int)fileno(fp)))
2368 return 1;
2369 if (!Py_InteractiveFlag)
2370 return 0;
2371 return (filename == NULL) ||
2372 (strcmp(filename, "<stdin>") == 0) ||
2373 (strcmp(filename, "???") == 0);
2374}
2375
2376
Nick Coghland6009512014-11-20 21:39:37 +10002377/* Wrappers around sigaction() or signal(). */
2378
2379PyOS_sighandler_t
2380PyOS_getsig(int sig)
2381{
2382#ifdef HAVE_SIGACTION
2383 struct sigaction context;
2384 if (sigaction(sig, NULL, &context) == -1)
2385 return SIG_ERR;
2386 return context.sa_handler;
2387#else
2388 PyOS_sighandler_t handler;
2389/* Special signal handling for the secure CRT in Visual Studio 2005 */
2390#if defined(_MSC_VER) && _MSC_VER >= 1400
2391 switch (sig) {
2392 /* Only these signals are valid */
2393 case SIGINT:
2394 case SIGILL:
2395 case SIGFPE:
2396 case SIGSEGV:
2397 case SIGTERM:
2398 case SIGBREAK:
2399 case SIGABRT:
2400 break;
2401 /* Don't call signal() with other values or it will assert */
2402 default:
2403 return SIG_ERR;
2404 }
2405#endif /* _MSC_VER && _MSC_VER >= 1400 */
2406 handler = signal(sig, SIG_IGN);
2407 if (handler != SIG_ERR)
2408 signal(sig, handler);
2409 return handler;
2410#endif
2411}
2412
2413/*
2414 * All of the code in this function must only use async-signal-safe functions,
2415 * listed at `man 7 signal` or
2416 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2417 */
2418PyOS_sighandler_t
2419PyOS_setsig(int sig, PyOS_sighandler_t handler)
2420{
2421#ifdef HAVE_SIGACTION
2422 /* Some code in Modules/signalmodule.c depends on sigaction() being
2423 * used here if HAVE_SIGACTION is defined. Fix that if this code
2424 * changes to invalidate that assumption.
2425 */
2426 struct sigaction context, ocontext;
2427 context.sa_handler = handler;
2428 sigemptyset(&context.sa_mask);
2429 context.sa_flags = 0;
2430 if (sigaction(sig, &context, &ocontext) == -1)
2431 return SIG_ERR;
2432 return ocontext.sa_handler;
2433#else
2434 PyOS_sighandler_t oldhandler;
2435 oldhandler = signal(sig, handler);
2436#ifdef HAVE_SIGINTERRUPT
2437 siginterrupt(sig, 1);
2438#endif
2439 return oldhandler;
2440#endif
2441}
2442
2443#ifdef __cplusplus
2444}
2445#endif