blob: feb928523924010ae3dedfb8f253a722e66a1c12 [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
735 status = _PyPreConfig_InitFromPreConfig(&config, src_config);
736 if (_PyStatus_EXCEPTION(status)) {
737 return status;
738 }
Victor Stinnerf72346c2019-03-25 17:54:58 +0100739
Victor Stinner331a6a52019-05-27 16:39:22 +0200740 status = _PyPreConfig_Read(&config, args);
741 if (_PyStatus_EXCEPTION(status)) {
742 return status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100743 }
744
Victor Stinner331a6a52019-05-27 16:39:22 +0200745 status = _PyPreConfig_Write(&config);
746 if (_PyStatus_EXCEPTION(status)) {
747 return status;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100748 }
749
Victor Stinner47bbab92019-09-18 14:10:16 +0200750 runtime->preinitializing = 0;
751 runtime->preinitialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200752 return _PyStatus_OK();
Victor Stinnerf72346c2019-03-25 17:54:58 +0100753}
754
Victor Stinner70005ac2019-05-02 15:25:34 -0400755
Victor Stinner331a6a52019-05-27 16:39:22 +0200756PyStatus
757Py_PreInitializeFromBytesArgs(const PyPreConfig *src_config, Py_ssize_t argc, char **argv)
Victor Stinnerf72346c2019-03-25 17:54:58 +0100758{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100759 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400760 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100761}
762
763
Victor Stinner331a6a52019-05-27 16:39:22 +0200764PyStatus
765Py_PreInitializeFromArgs(const PyPreConfig *src_config, Py_ssize_t argc, wchar_t **argv)
Victor Stinner20004952019-03-26 02:31:11 +0100766{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100767 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400768 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinner20004952019-03-26 02:31:11 +0100769}
770
771
Victor Stinner331a6a52019-05-27 16:39:22 +0200772PyStatus
773Py_PreInitialize(const PyPreConfig *src_config)
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100774{
Victor Stinner70005ac2019-05-02 15:25:34 -0400775 return _Py_PreInitializeFromPyArgv(src_config, NULL);
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100776}
777
778
Victor Stinner331a6a52019-05-27 16:39:22 +0200779PyStatus
780_Py_PreInitializeFromConfig(const PyConfig *config,
781 const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100782{
Victor Stinner331a6a52019-05-27 16:39:22 +0200783 assert(config != NULL);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200784
Victor Stinner331a6a52019-05-27 16:39:22 +0200785 PyStatus status = _PyRuntime_Initialize();
786 if (_PyStatus_EXCEPTION(status)) {
787 return status;
Victor Stinner6d1c4672019-05-20 11:02:00 +0200788 }
789 _PyRuntimeState *runtime = &_PyRuntime;
790
Victor Stinner47bbab92019-09-18 14:10:16 +0200791 if (runtime->preinitialized) {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200792 /* Already initialized: do nothing */
Victor Stinner331a6a52019-05-27 16:39:22 +0200793 return _PyStatus_OK();
Victor Stinner70005ac2019-05-02 15:25:34 -0400794 }
Victor Stinnercab5d072019-05-17 19:01:14 +0200795
Victor Stinner331a6a52019-05-27 16:39:22 +0200796 PyPreConfig preconfig;
Victor Stinner6e128382019-09-28 04:50:43 +0200797
Victor Stinnerbdace212019-10-01 00:46:42 +0200798 _PyPreConfig_InitFromConfig(&preconfig, config);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200799
Victor Stinner331a6a52019-05-27 16:39:22 +0200800 if (!config->parse_argv) {
801 return Py_PreInitialize(&preconfig);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200802 }
803 else if (args == NULL) {
Victor Stinnercab5d072019-05-17 19:01:14 +0200804 _PyArgv config_args = {
805 .use_bytes_argv = 0,
Victor Stinner331a6a52019-05-27 16:39:22 +0200806 .argc = config->argv.length,
807 .wchar_argv = config->argv.items};
Victor Stinner6d1c4672019-05-20 11:02:00 +0200808 return _Py_PreInitializeFromPyArgv(&preconfig, &config_args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200809 }
810 else {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200811 return _Py_PreInitializeFromPyArgv(&preconfig, args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200812 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100813}
814
815
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100816/* Begin interpreter initialization
817 *
818 * On return, the first thread and interpreter state have been created,
819 * but the compiler, signal handling, multithreading and
820 * multiple interpreter support, and codec infrastructure are not yet
821 * available.
822 *
823 * The import system will support builtin and frozen modules only.
824 * The only supported io is writing to sys.stderr
825 *
826 * If any operation invoked by this function fails, a fatal error is
827 * issued and the function does not return.
828 *
829 * Any code invoked from this function should *not* assume it has access
830 * to the Python C API (unless the API is explicitly listed as being
831 * safe to call without calling Py_Initialize first)
832 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200833static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200834pyinit_core(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200835 const PyConfig *src_config,
Victor Stinner5edcf262019-05-23 00:57:57 +0200836 PyInterpreterState **interp_p)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200837{
Victor Stinner331a6a52019-05-27 16:39:22 +0200838 PyStatus status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200839
Victor Stinner331a6a52019-05-27 16:39:22 +0200840 status = _Py_PreInitializeFromConfig(src_config, NULL);
841 if (_PyStatus_EXCEPTION(status)) {
842 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200843 }
844
Victor Stinner331a6a52019-05-27 16:39:22 +0200845 PyConfig config;
Miss Islington (bot)d49f0962019-10-01 03:26:04 -0700846 _PyConfig_InitCompatConfig(&config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200847
Victor Stinner331a6a52019-05-27 16:39:22 +0200848 status = _PyConfig_Copy(&config, src_config);
849 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200850 goto done;
851 }
852
Victor Stinner331a6a52019-05-27 16:39:22 +0200853 status = PyConfig_Read(&config);
854 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200855 goto done;
856 }
857
858 if (!runtime->core_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200859 status = pyinit_config(runtime, interp_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200860 }
861 else {
Victor Stinner331a6a52019-05-27 16:39:22 +0200862 status = pyinit_core_reconfigure(runtime, interp_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200863 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200864 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200865 goto done;
866 }
867
868done:
Victor Stinner331a6a52019-05-27 16:39:22 +0200869 PyConfig_Clear(&config);
870 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200871}
872
Victor Stinner5ac27a52019-03-27 13:40:14 +0100873
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200874/* Py_Initialize() has already been called: update the main interpreter
875 configuration. Example of bpo-34008: Py_Main() called after
876 Py_Initialize(). */
Victor Stinner331a6a52019-05-27 16:39:22 +0200877static PyStatus
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100878_Py_ReconfigureMainInterpreter(PyInterpreterState *interp)
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200879{
Victor Stinner331a6a52019-05-27 16:39:22 +0200880 PyConfig *config = &interp->config;
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100881
Victor Stinner331a6a52019-05-27 16:39:22 +0200882 PyObject *argv = _PyWideStringList_AsList(&config->argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100883 if (argv == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200884 return _PyStatus_NO_MEMORY(); \
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100885 }
886
887 int res = PyDict_SetItemString(interp->sysdict, "argv", argv);
888 Py_DECREF(argv);
889 if (res < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200890 return _PyStatus_ERR("fail to set sys.argv");
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200891 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200892 return _PyStatus_OK();
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200893}
894
Eric Snowc7ec9982017-05-23 23:00:52 -0700895/* Update interpreter state based on supplied configuration settings
896 *
897 * After calling this function, most of the restrictions on the interpreter
898 * are lifted. The only remaining incomplete settings are those related
899 * to the main module (sys.argv[0], __main__ metadata)
900 *
901 * Calling this when the interpreter is not initializing, is already
902 * initialized or without a valid current thread state is a fatal error.
903 * Other errors should be reported as normal Python exceptions with a
904 * non-zero return code.
905 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200906static PyStatus
Victor Stinner0fd2c302019-06-04 03:15:09 +0200907pyinit_main(_PyRuntimeState *runtime, PyInterpreterState *interp)
Eric Snow1abcf672017-05-23 21:46:51 -0700908{
Victor Stinner43125222019-04-24 18:23:53 +0200909 if (!runtime->core_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200910 return _PyStatus_ERR("runtime core not initialized");
Eric Snowc7ec9982017-05-23 23:00:52 -0700911 }
Eric Snowc7ec9982017-05-23 23:00:52 -0700912
Victor Stinner1dc6e392018-07-25 02:49:17 +0200913 /* Configure the main interpreter */
Victor Stinner331a6a52019-05-27 16:39:22 +0200914 PyConfig *config = &interp->config;
Eric Snowc7ec9982017-05-23 23:00:52 -0700915
Victor Stinner43125222019-04-24 18:23:53 +0200916 if (runtime->initialized) {
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100917 return _Py_ReconfigureMainInterpreter(interp);
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200918 }
919
Victor Stinner331a6a52019-05-27 16:39:22 +0200920 if (!config->_install_importlib) {
Eric Snow1abcf672017-05-23 21:46:51 -0700921 /* Special mode for freeze_importlib: run with no import system
922 *
923 * This means anything which needs support from extension modules
924 * or pure Python code in the standard library won't work.
925 */
Victor Stinner43125222019-04-24 18:23:53 +0200926 runtime->initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200927 return _PyStatus_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700928 }
Victor Stinner9316ee42017-11-25 03:17:57 +0100929
Victor Stinner33c377e2017-12-05 15:12:41 +0100930 if (_PyTime_Init() < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200931 return _PyStatus_ERR("can't initialize time");
Victor Stinner33c377e2017-12-05 15:12:41 +0100932 }
Victor Stinner13019fd2015-04-03 13:10:54 +0200933
Victor Stinner0fd2c302019-06-04 03:15:09 +0200934 if (_PySys_InitMain(runtime, interp) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200935 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerda273412017-12-15 01:46:02 +0100936 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800937
Victor Stinner331a6a52019-05-27 16:39:22 +0200938 PyStatus status = init_importlib_external(interp);
939 if (_PyStatus_EXCEPTION(status)) {
940 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800941 }
Nick Coghland6009512014-11-20 21:39:37 +1000942
943 /* initialize the faulthandler module */
Victor Stinner331a6a52019-05-27 16:39:22 +0200944 status = _PyFaulthandler_Init(config->faulthandler);
945 if (_PyStatus_EXCEPTION(status)) {
946 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800947 }
Nick Coghland6009512014-11-20 21:39:37 +1000948
Victor Stinnerc5c64252019-09-23 15:59:00 +0200949 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
950 status = _PyUnicode_InitEncodings(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200951 if (_PyStatus_EXCEPTION(status)) {
952 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800953 }
Nick Coghland6009512014-11-20 21:39:37 +1000954
Victor Stinner331a6a52019-05-27 16:39:22 +0200955 if (config->install_signal_handlers) {
956 status = init_signals();
957 if (_PyStatus_EXCEPTION(status)) {
958 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800959 }
960 }
Nick Coghland6009512014-11-20 21:39:37 +1000961
Victor Stinner331a6a52019-05-27 16:39:22 +0200962 if (_PyTraceMalloc_Init(config->tracemalloc) < 0) {
963 return _PyStatus_ERR("can't initialize tracemalloc");
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200964 }
Nick Coghland6009512014-11-20 21:39:37 +1000965
Victor Stinner331a6a52019-05-27 16:39:22 +0200966 status = add_main_module(interp);
967 if (_PyStatus_EXCEPTION(status)) {
968 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800969 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800970
Victor Stinner331a6a52019-05-27 16:39:22 +0200971 status = init_sys_streams(interp);
972 if (_PyStatus_EXCEPTION(status)) {
973 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800974 }
Nick Coghland6009512014-11-20 21:39:37 +1000975
976 /* Initialize warnings. */
Victor Stinner37cd9822018-11-16 11:55:35 +0100977 PyObject *warnoptions = PySys_GetObject("warnoptions");
978 if (warnoptions != NULL && PyList_Size(warnoptions) > 0)
Victor Stinner5d862462017-12-19 11:35:58 +0100979 {
Nick Coghland6009512014-11-20 21:39:37 +1000980 PyObject *warnings_module = PyImport_ImportModule("warnings");
981 if (warnings_module == NULL) {
982 fprintf(stderr, "'import warnings' failed; traceback:\n");
983 PyErr_Print();
984 }
985 Py_XDECREF(warnings_module);
986 }
987
Victor Stinner43125222019-04-24 18:23:53 +0200988 runtime->initialized = 1;
Eric Snow1abcf672017-05-23 21:46:51 -0700989
Victor Stinner331a6a52019-05-27 16:39:22 +0200990 if (config->site_import) {
991 status = init_import_size(); /* Module site */
992 if (_PyStatus_EXCEPTION(status)) {
993 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800994 }
995 }
Victor Stinnercf215042018-08-29 22:56:06 +0200996
997#ifndef MS_WINDOWS
Victor Stinner43125222019-04-24 18:23:53 +0200998 emit_stderr_warning_for_legacy_locale(runtime);
Victor Stinnercf215042018-08-29 22:56:06 +0200999#endif
1000
Victor Stinner331a6a52019-05-27 16:39:22 +02001001 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001002}
1003
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001004
Victor Stinner331a6a52019-05-27 16:39:22 +02001005PyStatus
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001006_Py_InitializeMain(void)
1007{
Victor Stinner331a6a52019-05-27 16:39:22 +02001008 PyStatus status = _PyRuntime_Initialize();
1009 if (_PyStatus_EXCEPTION(status)) {
1010 return status;
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001011 }
1012 _PyRuntimeState *runtime = &_PyRuntime;
1013 PyInterpreterState *interp = _PyRuntimeState_GetThreadState(runtime)->interp;
1014
Victor Stinner0fd2c302019-06-04 03:15:09 +02001015 return pyinit_main(runtime, interp);
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001016}
1017
1018
Victor Stinner331a6a52019-05-27 16:39:22 +02001019PyStatus
1020Py_InitializeFromConfig(const PyConfig *config)
Eric Snow1abcf672017-05-23 21:46:51 -07001021{
Victor Stinner6d1c4672019-05-20 11:02:00 +02001022 if (config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001023 return _PyStatus_ERR("initialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +02001024 }
1025
Victor Stinner331a6a52019-05-27 16:39:22 +02001026 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001027
Victor Stinner331a6a52019-05-27 16:39:22 +02001028 status = _PyRuntime_Initialize();
1029 if (_PyStatus_EXCEPTION(status)) {
1030 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001031 }
1032 _PyRuntimeState *runtime = &_PyRuntime;
1033
1034 PyInterpreterState *interp = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001035 status = pyinit_core(runtime, config, &interp);
1036 if (_PyStatus_EXCEPTION(status)) {
1037 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001038 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001039 config = &interp->config;
Victor Stinnerbc8ac6b2017-11-30 18:03:55 +01001040
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001041 if (config->_init_main) {
Victor Stinner0fd2c302019-06-04 03:15:09 +02001042 status = pyinit_main(runtime, interp);
Victor Stinner331a6a52019-05-27 16:39:22 +02001043 if (_PyStatus_EXCEPTION(status)) {
1044 return status;
Victor Stinner484f20d2019-03-27 02:04:16 +01001045 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001046 }
Victor Stinner484f20d2019-03-27 02:04:16 +01001047
Victor Stinner331a6a52019-05-27 16:39:22 +02001048 return _PyStatus_OK();
Victor Stinner5ac27a52019-03-27 13:40:14 +01001049}
1050
1051
Eric Snow1abcf672017-05-23 21:46:51 -07001052void
Nick Coghland6009512014-11-20 21:39:37 +10001053Py_InitializeEx(int install_sigs)
1054{
Victor Stinner331a6a52019-05-27 16:39:22 +02001055 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001056
Victor Stinner331a6a52019-05-27 16:39:22 +02001057 status = _PyRuntime_Initialize();
1058 if (_PyStatus_EXCEPTION(status)) {
1059 Py_ExitStatusException(status);
Victor Stinner43125222019-04-24 18:23:53 +02001060 }
1061 _PyRuntimeState *runtime = &_PyRuntime;
1062
1063 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001064 /* bpo-33932: Calling Py_Initialize() twice does nothing. */
1065 return;
1066 }
1067
Victor Stinner331a6a52019-05-27 16:39:22 +02001068 PyConfig config;
Miss Islington (bot)d49f0962019-10-01 03:26:04 -07001069 _PyConfig_InitCompatConfig(&config);
Victor Stinner6e128382019-09-28 04:50:43 +02001070
Victor Stinner1dc6e392018-07-25 02:49:17 +02001071 config.install_signal_handlers = install_sigs;
1072
Victor Stinner331a6a52019-05-27 16:39:22 +02001073 status = Py_InitializeFromConfig(&config);
1074 if (_PyStatus_EXCEPTION(status)) {
1075 Py_ExitStatusException(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001076 }
Nick Coghland6009512014-11-20 21:39:37 +10001077}
1078
1079void
1080Py_Initialize(void)
1081{
1082 Py_InitializeEx(1);
1083}
1084
1085
1086#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001087extern void _Py_dump_counts(FILE*);
Nick Coghland6009512014-11-20 21:39:37 +10001088#endif
1089
1090/* Flush stdout and stderr */
1091
1092static int
1093file_is_closed(PyObject *fobj)
1094{
1095 int r;
1096 PyObject *tmp = PyObject_GetAttrString(fobj, "closed");
1097 if (tmp == NULL) {
1098 PyErr_Clear();
1099 return 0;
1100 }
1101 r = PyObject_IsTrue(tmp);
1102 Py_DECREF(tmp);
1103 if (r < 0)
1104 PyErr_Clear();
1105 return r > 0;
1106}
1107
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001108static int
Nick Coghland6009512014-11-20 21:39:37 +10001109flush_std_files(void)
1110{
1111 PyObject *fout = _PySys_GetObjectId(&PyId_stdout);
1112 PyObject *ferr = _PySys_GetObjectId(&PyId_stderr);
1113 PyObject *tmp;
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001114 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001115
1116 if (fout != NULL && fout != Py_None && !file_is_closed(fout)) {
Victor Stinner3466bde2016-09-05 18:16:01 -07001117 tmp = _PyObject_CallMethodId(fout, &PyId_flush, NULL);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001118 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001119 PyErr_WriteUnraisable(fout);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001120 status = -1;
1121 }
Nick Coghland6009512014-11-20 21:39:37 +10001122 else
1123 Py_DECREF(tmp);
1124 }
1125
1126 if (ferr != NULL && ferr != Py_None && !file_is_closed(ferr)) {
Victor Stinner3466bde2016-09-05 18:16:01 -07001127 tmp = _PyObject_CallMethodId(ferr, &PyId_flush, NULL);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001128 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001129 PyErr_Clear();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001130 status = -1;
1131 }
Nick Coghland6009512014-11-20 21:39:37 +10001132 else
1133 Py_DECREF(tmp);
1134 }
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001135
1136 return status;
Nick Coghland6009512014-11-20 21:39:37 +10001137}
1138
1139/* Undo the effect of Py_Initialize().
1140
1141 Beware: if multiple interpreter and/or thread states exist, these
1142 are not wiped out; only the current thread and interpreter state
1143 are deleted. But since everything else is deleted, those other
1144 interpreter and thread states should no longer be used.
1145
1146 (XXX We should do better, e.g. wipe out all interpreters and
1147 threads.)
1148
1149 Locking: as above.
1150
1151*/
1152
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001153int
1154Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001155{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001156 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001157
Victor Stinner8e91c242019-04-24 17:24:01 +02001158 _PyRuntimeState *runtime = &_PyRuntime;
1159 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001160 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001161 }
Nick Coghland6009512014-11-20 21:39:37 +10001162
Eric Snow842a2f02019-03-15 15:47:51 -06001163 // Wrap up existing "threading"-module-created, non-daemon threads.
Nick Coghland6009512014-11-20 21:39:37 +10001164 wait_for_thread_shutdown();
1165
Eric Snow842a2f02019-03-15 15:47:51 -06001166 // Make any remaining pending calls.
Victor Stinnere225beb2019-06-03 18:14:24 +02001167 _Py_FinishPendingCalls(runtime);
1168
1169 /* Get current thread state and interpreter pointer */
1170 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
1171 PyInterpreterState *interp = tstate->interp;
Victor Stinner8e91c242019-04-24 17:24:01 +02001172
Nick Coghland6009512014-11-20 21:39:37 +10001173 /* The interpreter is still entirely intact at this point, and the
1174 * exit funcs may be relying on that. In particular, if some thread
1175 * or exit func is still waiting to do an import, the import machinery
1176 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001177 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001178 * Note that Threading.py uses an exit func to do a join on all the
1179 * threads created thru it, so this also protects pending imports in
1180 * the threads created via Threading.
1181 */
Nick Coghland6009512014-11-20 21:39:37 +10001182
Marcel Plch776407f2017-12-20 11:17:58 +01001183 call_py_exitfuncs(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001184
Victor Stinnerda273412017-12-15 01:46:02 +01001185 /* Copy the core config, PyInterpreterState_Delete() free
1186 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001187#ifdef Py_REF_DEBUG
Victor Stinner331a6a52019-05-27 16:39:22 +02001188 int show_ref_count = interp->config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001189#endif
1190#ifdef Py_TRACE_REFS
Victor Stinner331a6a52019-05-27 16:39:22 +02001191 int dump_refs = interp->config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001192#endif
1193#ifdef WITH_PYMALLOC
Victor Stinner331a6a52019-05-27 16:39:22 +02001194 int malloc_stats = interp->config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001195#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001196
Nick Coghland6009512014-11-20 21:39:37 +10001197 /* Remaining threads (e.g. daemon threads) will automatically exit
1198 after taking the GIL (in PyEval_RestoreThread()). */
Victor Stinner8e91c242019-04-24 17:24:01 +02001199 runtime->finalizing = tstate;
1200 runtime->initialized = 0;
1201 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001202
Victor Stinnere0deff32015-03-24 13:46:18 +01001203 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001204 if (flush_std_files() < 0) {
1205 status = -1;
1206 }
Nick Coghland6009512014-11-20 21:39:37 +10001207
1208 /* Disable signal handling */
1209 PyOS_FiniInterrupts();
1210
1211 /* Collect garbage. This may call finalizers; it's nice to call these
1212 * before all modules are destroyed.
1213 * XXX If a __del__ or weakref callback is triggered here, and tries to
1214 * XXX import a module, bad things can happen, because Python no
1215 * XXX longer believes it's initialized.
1216 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1217 * XXX is easy to provoke that way. I've also seen, e.g.,
1218 * XXX Exception exceptions.ImportError: 'No module named sha'
1219 * XXX in <function callback at 0x008F5718> ignored
1220 * XXX but I'm unclear on exactly how that one happens. In any case,
1221 * XXX I haven't seen a real-life report of either of these.
1222 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001223 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001224#ifdef COUNT_ALLOCS
1225 /* With COUNT_ALLOCS, it helps to run GC multiple times:
1226 each collection might release some types from the type
1227 list, so they become garbage. */
Łukasz Langafef7e942016-09-09 21:47:46 -07001228 while (_PyGC_CollectIfEnabled() > 0)
Nick Coghland6009512014-11-20 21:39:37 +10001229 /* nothing */;
1230#endif
Eric Snowdae02762017-09-14 00:35:58 -07001231
Steve Dowerb82e17e2019-05-23 08:45:22 -07001232 /* Clear all loghooks */
1233 /* We want minimal exposure of this function, so define the extern
1234 * here. The linker should discover the correct function without
1235 * exporting a symbol. */
1236 extern void _PySys_ClearAuditHooks(void);
1237 _PySys_ClearAuditHooks();
1238
Nick Coghland6009512014-11-20 21:39:37 +10001239 /* Destroy all modules */
1240 PyImport_Cleanup();
1241
Inada Naoki91234a12019-06-03 21:30:58 +09001242 /* Print debug stats if any */
1243 _PyEval_Fini();
1244
Victor Stinnere0deff32015-03-24 13:46:18 +01001245 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001246 if (flush_std_files() < 0) {
1247 status = -1;
1248 }
Nick Coghland6009512014-11-20 21:39:37 +10001249
1250 /* Collect final garbage. This disposes of cycles created by
1251 * class definitions, for example.
1252 * XXX This is disabled because it caused too many problems. If
1253 * XXX a __del__ or weakref callback triggers here, Python code has
1254 * XXX a hard time running, because even the sys module has been
1255 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1256 * XXX One symptom is a sequence of information-free messages
1257 * XXX coming from threads (if a __del__ or callback is invoked,
1258 * XXX other threads can execute too, and any exception they encounter
1259 * XXX triggers a comedy of errors as subsystem after subsystem
1260 * XXX fails to find what it *expects* to find in sys to help report
1261 * XXX the exception and consequent unexpected failures). I've also
1262 * XXX seen segfaults then, after adding print statements to the
1263 * XXX Python code getting called.
1264 */
1265#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001266 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001267#endif
1268
1269 /* Disable tracemalloc after all Python objects have been destroyed,
1270 so it is possible to use tracemalloc in objects destructor. */
1271 _PyTraceMalloc_Fini();
1272
1273 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1274 _PyImport_Fini();
1275
1276 /* Cleanup typeobject.c's internal caches. */
1277 _PyType_Fini();
1278
1279 /* unload faulthandler module */
1280 _PyFaulthandler_Fini();
1281
1282 /* Debugging stuff */
1283#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001284 _Py_dump_counts(stderr);
Nick Coghland6009512014-11-20 21:39:37 +10001285#endif
1286 /* dump hash stats */
1287 _PyHash_Fini();
1288
Eric Snowdae02762017-09-14 00:35:58 -07001289#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001290 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001291 _PyDebug_PrintTotalRefs();
1292 }
Eric Snowdae02762017-09-14 00:35:58 -07001293#endif
Nick Coghland6009512014-11-20 21:39:37 +10001294
1295#ifdef Py_TRACE_REFS
1296 /* Display all objects still alive -- this can invoke arbitrary
1297 * __repr__ overrides, so requires a mostly-intact interpreter.
1298 * Alas, a lot of stuff may still be alive now that will be cleaned
1299 * up later.
1300 */
Victor Stinnerda273412017-12-15 01:46:02 +01001301 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001302 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001303 }
Nick Coghland6009512014-11-20 21:39:37 +10001304#endif /* Py_TRACE_REFS */
1305
1306 /* Clear interpreter state and all thread states. */
1307 PyInterpreterState_Clear(interp);
1308
1309 /* Now we decref the exception classes. After this point nothing
1310 can raise an exception. That's okay, because each Fini() method
1311 below has been checked to make sure no exceptions are ever
1312 raised.
1313 */
1314
1315 _PyExc_Fini();
1316
1317 /* Sundry finalizers */
1318 PyMethod_Fini();
1319 PyFrame_Fini();
1320 PyCFunction_Fini();
1321 PyTuple_Fini();
1322 PyList_Fini();
1323 PySet_Fini();
1324 PyBytes_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001325 PyLong_Fini();
1326 PyFloat_Fini();
1327 PyDict_Fini();
1328 PySlice_Fini();
Victor Stinner8e91c242019-04-24 17:24:01 +02001329 _PyGC_Fini(runtime);
Eric Snow86ea5812019-05-10 13:29:55 -04001330 _PyWarnings_Fini(interp);
Eric Snow6b4be192017-05-22 21:36:03 -07001331 _Py_HashRandomization_Fini();
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001332 _PyArg_Fini();
Yury Selivanoveb636452016-09-08 22:01:51 -07001333 PyAsyncGen_Fini();
Yury Selivanovf23746a2018-01-22 19:11:18 -05001334 _PyContext_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001335
1336 /* Cleanup Unicode implementation */
1337 _PyUnicode_Fini();
1338
Victor Stinnerb2457ef2018-08-29 13:25:36 +02001339 _Py_ClearFileSystemEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10001340
1341 /* XXX Still allocated:
1342 - various static ad-hoc pointers to interned strings
1343 - int and float free list blocks
1344 - whatever various modules and libraries allocate
1345 */
1346
1347 PyGrammar_RemoveAccelerators(&_PyParser_Grammar);
1348
1349 /* Cleanup auto-thread-state */
Victor Stinner8e91c242019-04-24 17:24:01 +02001350 _PyGILState_Fini(runtime);
Nick Coghland6009512014-11-20 21:39:37 +10001351
1352 /* Delete current thread. After this, many C API calls become crashy. */
1353 PyThreadState_Swap(NULL);
Victor Stinner8a1be612016-03-14 22:07:55 +01001354
Nick Coghland6009512014-11-20 21:39:37 +10001355 PyInterpreterState_Delete(interp);
1356
1357#ifdef Py_TRACE_REFS
1358 /* Display addresses (& refcnts) of all objects still alive.
1359 * An address can be used to find the repr of the object, printed
1360 * above by _Py_PrintReferences.
1361 */
Victor Stinnerda273412017-12-15 01:46:02 +01001362 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001363 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001364 }
Nick Coghland6009512014-11-20 21:39:37 +10001365#endif /* Py_TRACE_REFS */
Victor Stinner34be8072016-03-14 12:04:26 +01001366#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001367 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001368 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be8072016-03-14 12:04:26 +01001369 }
Nick Coghland6009512014-11-20 21:39:37 +10001370#endif
1371
Victor Stinner8e91c242019-04-24 17:24:01 +02001372 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001373
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001374 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001375 return status;
1376}
1377
1378void
1379Py_Finalize(void)
1380{
1381 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001382}
1383
1384/* Create and initialize a new interpreter and thread, and return the
1385 new thread. This requires that Py_Initialize() has been called
1386 first.
1387
1388 Unsuccessful initialization yields a NULL pointer. Note that *no*
1389 exception information is available even in this case -- the
1390 exception information is held in the thread, and there is no
1391 thread.
1392
1393 Locking: as above.
1394
1395*/
1396
Victor Stinner331a6a52019-05-27 16:39:22 +02001397static PyStatus
Victor Stinnera7368ac2017-11-15 18:11:45 -08001398new_interpreter(PyThreadState **tstate_p)
Nick Coghland6009512014-11-20 21:39:37 +10001399{
Victor Stinner331a6a52019-05-27 16:39:22 +02001400 PyStatus status;
Nick Coghland6009512014-11-20 21:39:37 +10001401
Victor Stinner331a6a52019-05-27 16:39:22 +02001402 status = _PyRuntime_Initialize();
1403 if (_PyStatus_EXCEPTION(status)) {
1404 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001405 }
1406 _PyRuntimeState *runtime = &_PyRuntime;
1407
1408 if (!runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001409 return _PyStatus_ERR("Py_Initialize must be called first");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001410 }
Nick Coghland6009512014-11-20 21:39:37 +10001411
Victor Stinner8a1be612016-03-14 22:07:55 +01001412 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1413 interpreters: disable PyGILState_Check(). */
1414 _PyGILState_check_enabled = 0;
1415
Victor Stinner43125222019-04-24 18:23:53 +02001416 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001417 if (interp == NULL) {
1418 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001419 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001420 }
Nick Coghland6009512014-11-20 21:39:37 +10001421
Victor Stinner43125222019-04-24 18:23:53 +02001422 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001423 if (tstate == NULL) {
1424 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001425 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001426 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001427 }
1428
Victor Stinner43125222019-04-24 18:23:53 +02001429 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001430
Eric Snow1abcf672017-05-23 21:46:51 -07001431 /* Copy the current interpreter config into the new interpreter */
Victor Stinner331a6a52019-05-27 16:39:22 +02001432 PyConfig *config;
Eric Snow1abcf672017-05-23 21:46:51 -07001433 if (save_tstate != NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001434 config = &save_tstate->interp->config;
Eric Snow1abcf672017-05-23 21:46:51 -07001435 } else {
1436 /* No current thread state, copy from the main interpreter */
1437 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinner331a6a52019-05-27 16:39:22 +02001438 config = &main_interp->config;
Victor Stinnerda273412017-12-15 01:46:02 +01001439 }
1440
Victor Stinner331a6a52019-05-27 16:39:22 +02001441 status = _PyConfig_Copy(&interp->config, config);
1442 if (_PyStatus_EXCEPTION(status)) {
1443 return status;
Victor Stinnerda273412017-12-15 01:46:02 +01001444 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001445 config = &interp->config;
Eric Snow1abcf672017-05-23 21:46:51 -07001446
Victor Stinner331a6a52019-05-27 16:39:22 +02001447 status = _PyExc_Init();
1448 if (_PyStatus_EXCEPTION(status)) {
1449 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001450 }
1451
Victor Stinner331a6a52019-05-27 16:39:22 +02001452 status = _PyErr_Init();
1453 if (_PyStatus_EXCEPTION(status)) {
1454 return status;
Victor Stinneref9d9b62019-05-22 11:28:22 +02001455 }
1456
1457
Nick Coghland6009512014-11-20 21:39:37 +10001458 /* XXX The following is lax in error checking */
Eric Snowd393c1b2017-09-14 12:18:12 -06001459 PyObject *modules = PyDict_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001460 if (modules == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001461 return _PyStatus_ERR("can't make modules dictionary");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001462 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001463 interp->modules = modules;
Nick Coghland6009512014-11-20 21:39:37 +10001464
Victor Stinner43125222019-04-24 18:23:53 +02001465 PyObject *sysmod = _PyImport_FindBuiltin("sys", modules);
Eric Snowd393c1b2017-09-14 12:18:12 -06001466 if (sysmod != NULL) {
1467 interp->sysdict = PyModule_GetDict(sysmod);
Victor Stinner43125222019-04-24 18:23:53 +02001468 if (interp->sysdict == NULL) {
Eric Snowd393c1b2017-09-14 12:18:12 -06001469 goto handle_error;
Victor Stinner43125222019-04-24 18:23:53 +02001470 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001471 Py_INCREF(interp->sysdict);
1472 PyDict_SetItemString(interp->sysdict, "modules", modules);
Victor Stinner0fd2c302019-06-04 03:15:09 +02001473 if (_PySys_InitMain(runtime, interp) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001474 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerab672812019-01-23 15:04:40 +01001475 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001476 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001477 else if (PyErr_Occurred()) {
1478 goto handle_error;
1479 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001480
Victor Stinner43125222019-04-24 18:23:53 +02001481 PyObject *bimod = _PyImport_FindBuiltin("builtins", modules);
Nick Coghland6009512014-11-20 21:39:37 +10001482 if (bimod != NULL) {
1483 interp->builtins = PyModule_GetDict(bimod);
1484 if (interp->builtins == NULL)
1485 goto handle_error;
1486 Py_INCREF(interp->builtins);
1487 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001488 else if (PyErr_Occurred()) {
1489 goto handle_error;
1490 }
Nick Coghland6009512014-11-20 21:39:37 +10001491
Nick Coghland6009512014-11-20 21:39:37 +10001492 if (bimod != NULL && sysmod != NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001493 status = _PyBuiltins_AddExceptions(bimod);
1494 if (_PyStatus_EXCEPTION(status)) {
1495 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001496 }
Nick Coghland6009512014-11-20 21:39:37 +10001497
Victor Stinner331a6a52019-05-27 16:39:22 +02001498 status = _PySys_SetPreliminaryStderr(interp->sysdict);
1499 if (_PyStatus_EXCEPTION(status)) {
1500 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001501 }
Nick Coghland6009512014-11-20 21:39:37 +10001502
Victor Stinner331a6a52019-05-27 16:39:22 +02001503 status = _PyImportHooks_Init();
1504 if (_PyStatus_EXCEPTION(status)) {
1505 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001506 }
Nick Coghland6009512014-11-20 21:39:37 +10001507
Victor Stinner331a6a52019-05-27 16:39:22 +02001508 status = init_importlib(interp, sysmod);
1509 if (_PyStatus_EXCEPTION(status)) {
1510 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001511 }
Nick Coghland6009512014-11-20 21:39:37 +10001512
Victor Stinner331a6a52019-05-27 16:39:22 +02001513 status = init_importlib_external(interp);
1514 if (_PyStatus_EXCEPTION(status)) {
1515 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001516 }
Nick Coghland6009512014-11-20 21:39:37 +10001517
Victor Stinnerc5c64252019-09-23 15:59:00 +02001518 status = _PyUnicode_InitEncodings(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001519 if (_PyStatus_EXCEPTION(status)) {
1520 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001521 }
1522
Victor Stinner331a6a52019-05-27 16:39:22 +02001523 status = init_sys_streams(interp);
1524 if (_PyStatus_EXCEPTION(status)) {
1525 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001526 }
1527
Victor Stinner331a6a52019-05-27 16:39:22 +02001528 status = add_main_module(interp);
1529 if (_PyStatus_EXCEPTION(status)) {
1530 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001531 }
1532
Victor Stinner331a6a52019-05-27 16:39:22 +02001533 if (config->site_import) {
1534 status = init_import_size();
1535 if (_PyStatus_EXCEPTION(status)) {
1536 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001537 }
1538 }
Nick Coghland6009512014-11-20 21:39:37 +10001539 }
1540
Victor Stinnera7368ac2017-11-15 18:11:45 -08001541 if (PyErr_Occurred()) {
1542 goto handle_error;
1543 }
Nick Coghland6009512014-11-20 21:39:37 +10001544
Victor Stinnera7368ac2017-11-15 18:11:45 -08001545 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +02001546 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001547
Nick Coghland6009512014-11-20 21:39:37 +10001548handle_error:
1549 /* Oops, it didn't work. Undo it all. */
1550
1551 PyErr_PrintEx(0);
1552 PyThreadState_Clear(tstate);
1553 PyThreadState_Swap(save_tstate);
1554 PyThreadState_Delete(tstate);
1555 PyInterpreterState_Delete(interp);
1556
Victor Stinnera7368ac2017-11-15 18:11:45 -08001557 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001558 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001559}
1560
1561PyThreadState *
1562Py_NewInterpreter(void)
1563{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001564 PyThreadState *tstate = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001565 PyStatus status = new_interpreter(&tstate);
1566 if (_PyStatus_EXCEPTION(status)) {
1567 Py_ExitStatusException(status);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001568 }
1569 return tstate;
1570
Nick Coghland6009512014-11-20 21:39:37 +10001571}
1572
1573/* Delete an interpreter and its last thread. This requires that the
1574 given thread state is current, that the thread has no remaining
1575 frames, and that it is its interpreter's only remaining thread.
1576 It is a fatal error to violate these constraints.
1577
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001578 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001579 everything, regardless.)
1580
1581 Locking: as above.
1582
1583*/
1584
1585void
1586Py_EndInterpreter(PyThreadState *tstate)
1587{
1588 PyInterpreterState *interp = tstate->interp;
1589
Victor Stinner50b48572018-11-01 01:51:40 +01001590 if (tstate != _PyThreadState_GET())
Nick Coghland6009512014-11-20 21:39:37 +10001591 Py_FatalError("Py_EndInterpreter: thread is not current");
1592 if (tstate->frame != NULL)
1593 Py_FatalError("Py_EndInterpreter: thread still has a frame");
Eric Snow5be45a62019-03-08 22:47:07 -07001594 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001595
Eric Snow842a2f02019-03-15 15:47:51 -06001596 // Wrap up existing "threading"-module-created, non-daemon threads.
Nick Coghland6009512014-11-20 21:39:37 +10001597 wait_for_thread_shutdown();
1598
Marcel Plch776407f2017-12-20 11:17:58 +01001599 call_py_exitfuncs(interp);
1600
Nick Coghland6009512014-11-20 21:39:37 +10001601 if (tstate != interp->tstate_head || tstate->next != NULL)
1602 Py_FatalError("Py_EndInterpreter: not the last thread");
1603
1604 PyImport_Cleanup();
1605 PyInterpreterState_Clear(interp);
1606 PyThreadState_Swap(NULL);
1607 PyInterpreterState_Delete(interp);
1608}
1609
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001610/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001611
Victor Stinner331a6a52019-05-27 16:39:22 +02001612static PyStatus
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001613add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001614{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001615 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001616 m = PyImport_AddModule("__main__");
1617 if (m == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +02001618 return _PyStatus_ERR("can't create __main__ module");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001619
Nick Coghland6009512014-11-20 21:39:37 +10001620 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001621 ann_dict = PyDict_New();
1622 if ((ann_dict == NULL) ||
1623 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001624 return _PyStatus_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001625 }
1626 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001627
Nick Coghland6009512014-11-20 21:39:37 +10001628 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1629 PyObject *bimod = PyImport_ImportModule("builtins");
1630 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001631 return _PyStatus_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001632 }
1633 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001634 return _PyStatus_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001635 }
1636 Py_DECREF(bimod);
1637 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001638
Nick Coghland6009512014-11-20 21:39:37 +10001639 /* Main is a little special - imp.is_builtin("__main__") will return
1640 * False, but BuiltinImporter is still the most appropriate initial
1641 * setting for its __loader__ attribute. A more suitable value will
1642 * be set if __main__ gets further initialized later in the startup
1643 * process.
1644 */
1645 loader = PyDict_GetItemString(d, "__loader__");
1646 if (loader == NULL || loader == Py_None) {
1647 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1648 "BuiltinImporter");
1649 if (loader == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001650 return _PyStatus_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001651 }
1652 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001653 return _PyStatus_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001654 }
1655 Py_DECREF(loader);
1656 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001657 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001658}
1659
Nick Coghland6009512014-11-20 21:39:37 +10001660/* Import the site module (not into __main__ though) */
1661
Victor Stinner331a6a52019-05-27 16:39:22 +02001662static PyStatus
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001663init_import_size(void)
Nick Coghland6009512014-11-20 21:39:37 +10001664{
1665 PyObject *m;
1666 m = PyImport_ImportModule("site");
1667 if (m == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001668 return _PyStatus_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001669 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001670 Py_DECREF(m);
Victor Stinner331a6a52019-05-27 16:39:22 +02001671 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001672}
1673
Victor Stinner874dbe82015-09-04 17:29:57 +02001674/* Check if a file descriptor is valid or not.
1675 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1676static int
1677is_valid_fd(int fd)
1678{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001679/* dup() is faster than fstat(): fstat() can require input/output operations,
1680 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1681 startup. Problem: dup() doesn't check if the file descriptor is valid on
1682 some platforms.
1683
1684 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1685 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1686 EBADF. FreeBSD has similar issue (bpo-32849).
1687
1688 Only use dup() on platforms where dup() is enough to detect invalid FD in
1689 corner cases: on Linux and Windows (bpo-32849). */
1690#if defined(__linux__) || defined(MS_WINDOWS)
1691 if (fd < 0) {
1692 return 0;
1693 }
1694 int fd2;
1695
1696 _Py_BEGIN_SUPPRESS_IPH
1697 fd2 = dup(fd);
1698 if (fd2 >= 0) {
1699 close(fd2);
1700 }
1701 _Py_END_SUPPRESS_IPH
1702
1703 return (fd2 >= 0);
1704#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001705 struct stat st;
1706 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001707#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001708}
1709
1710/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001711static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02001712create_stdio(const PyConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001713 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001714 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001715{
1716 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1717 const char* mode;
1718 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001719 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001720 int buffering, isatty;
1721 _Py_IDENTIFIER(open);
1722 _Py_IDENTIFIER(isatty);
1723 _Py_IDENTIFIER(TextIOWrapper);
1724 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001725 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001726
Victor Stinner874dbe82015-09-04 17:29:57 +02001727 if (!is_valid_fd(fd))
1728 Py_RETURN_NONE;
1729
Nick Coghland6009512014-11-20 21:39:37 +10001730 /* stdin is always opened in buffered mode, first because it shouldn't
1731 make a difference in common use cases, second because TextIOWrapper
1732 depends on the presence of a read1() method which only exists on
1733 buffered streams.
1734 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001735 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001736 buffering = 0;
1737 else
1738 buffering = -1;
1739 if (write_mode)
1740 mode = "wb";
1741 else
1742 mode = "rb";
1743 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOi",
1744 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001745 Py_None, Py_None, /* encoding, errors */
1746 Py_None, 0); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001747 if (buf == NULL)
1748 goto error;
1749
1750 if (buffering) {
1751 _Py_IDENTIFIER(raw);
1752 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1753 if (raw == NULL)
1754 goto error;
1755 }
1756 else {
1757 raw = buf;
1758 Py_INCREF(raw);
1759 }
1760
Steve Dower39294992016-08-30 21:22:36 -07001761#ifdef MS_WINDOWS
1762 /* Windows console IO is always UTF-8 encoded */
1763 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001764 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001765#endif
1766
Nick Coghland6009512014-11-20 21:39:37 +10001767 text = PyUnicode_FromString(name);
1768 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1769 goto error;
Victor Stinner3466bde2016-09-05 18:16:01 -07001770 res = _PyObject_CallMethodId(raw, &PyId_isatty, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10001771 if (res == NULL)
1772 goto error;
1773 isatty = PyObject_IsTrue(res);
1774 Py_DECREF(res);
1775 if (isatty == -1)
1776 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001777 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001778 write_through = Py_True;
1779 else
1780 write_through = Py_False;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001781 if (isatty && buffered_stdio)
Nick Coghland6009512014-11-20 21:39:37 +10001782 line_buffering = Py_True;
1783 else
1784 line_buffering = Py_False;
1785
1786 Py_CLEAR(raw);
1787 Py_CLEAR(text);
1788
1789#ifdef MS_WINDOWS
1790 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1791 newlines to "\n".
1792 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1793 newline = NULL;
1794#else
1795 /* sys.stdin: split lines at "\n".
1796 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1797 newline = "\n";
1798#endif
1799
Victor Stinner709d23d2019-05-02 14:56:30 -04001800 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1801 if (encoding_str == NULL) {
1802 Py_CLEAR(buf);
1803 goto error;
1804 }
1805
1806 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1807 if (errors_str == NULL) {
1808 Py_CLEAR(buf);
1809 Py_CLEAR(encoding_str);
1810 goto error;
1811 }
1812
1813 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1814 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001815 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001816 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001817 Py_CLEAR(encoding_str);
1818 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001819 if (stream == NULL)
1820 goto error;
1821
1822 if (write_mode)
1823 mode = "w";
1824 else
1825 mode = "r";
1826 text = PyUnicode_FromString(mode);
1827 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1828 goto error;
1829 Py_CLEAR(text);
1830 return stream;
1831
1832error:
1833 Py_XDECREF(buf);
1834 Py_XDECREF(stream);
1835 Py_XDECREF(text);
1836 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001837
Victor Stinner874dbe82015-09-04 17:29:57 +02001838 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1839 /* Issue #24891: the file descriptor was closed after the first
1840 is_valid_fd() check was called. Ignore the OSError and set the
1841 stream to None. */
1842 PyErr_Clear();
1843 Py_RETURN_NONE;
1844 }
1845 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001846}
1847
1848/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinner331a6a52019-05-27 16:39:22 +02001849static PyStatus
Victor Stinner91106cd2017-12-13 12:29:09 +01001850init_sys_streams(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001851{
1852 PyObject *iomod = NULL, *wrapper;
1853 PyObject *bimod = NULL;
1854 PyObject *m;
1855 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001856 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001857 PyObject * encoding_attr;
Victor Stinner331a6a52019-05-27 16:39:22 +02001858 PyStatus res = _PyStatus_OK();
1859 PyConfig *config = &interp->config;
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001860
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001861 /* Check that stdin is not a directory
1862 Using shell redirection, you can redirect stdin to a directory,
1863 crashing the Python interpreter. Catch this common mistake here
1864 and output a useful error message. Note that under MS Windows,
1865 the shell already prevents that. */
1866#ifndef MS_WINDOWS
1867 struct _Py_stat_struct sb;
1868 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1869 S_ISDIR(sb.st_mode)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001870 return _PyStatus_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001871 }
1872#endif
1873
Nick Coghland6009512014-11-20 21:39:37 +10001874 /* Hack to avoid a nasty recursion issue when Python is invoked
1875 in verbose mode: pre-import the Latin-1 and UTF-8 codecs */
1876 if ((m = PyImport_ImportModule("encodings.utf_8")) == NULL) {
1877 goto error;
1878 }
1879 Py_DECREF(m);
1880
1881 if (!(m = PyImport_ImportModule("encodings.latin_1"))) {
1882 goto error;
1883 }
1884 Py_DECREF(m);
1885
1886 if (!(bimod = PyImport_ImportModule("builtins"))) {
1887 goto error;
1888 }
1889
1890 if (!(iomod = PyImport_ImportModule("io"))) {
1891 goto error;
1892 }
1893 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1894 goto error;
1895 }
1896
1897 /* Set builtins.open */
1898 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1899 Py_DECREF(wrapper);
1900 goto error;
1901 }
1902 Py_DECREF(wrapper);
1903
Nick Coghland6009512014-11-20 21:39:37 +10001904 /* Set sys.stdin */
1905 fd = fileno(stdin);
1906 /* Under some conditions stdin, stdout and stderr may not be connected
1907 * and fileno() may point to an invalid file descriptor. For example
1908 * GUI apps don't have valid standard streams by default.
1909 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001910 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001911 config->stdio_encoding,
1912 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001913 if (std == NULL)
1914 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001915 PySys_SetObject("__stdin__", std);
1916 _PySys_SetObjectId(&PyId_stdin, std);
1917 Py_DECREF(std);
1918
1919 /* Set sys.stdout */
1920 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001921 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001922 config->stdio_encoding,
1923 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001924 if (std == NULL)
1925 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001926 PySys_SetObject("__stdout__", std);
1927 _PySys_SetObjectId(&PyId_stdout, std);
1928 Py_DECREF(std);
1929
1930#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
1931 /* Set sys.stderr, replaces the preliminary stderr */
1932 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001933 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001934 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04001935 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02001936 if (std == NULL)
1937 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001938
1939 /* Same as hack above, pre-import stderr's codec to avoid recursion
1940 when import.c tries to write to stderr in verbose mode. */
1941 encoding_attr = PyObject_GetAttrString(std, "encoding");
1942 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001943 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10001944 if (std_encoding != NULL) {
1945 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
1946 Py_XDECREF(codec_info);
1947 }
1948 Py_DECREF(encoding_attr);
1949 }
1950 PyErr_Clear(); /* Not a fatal error if codec isn't available */
1951
1952 if (PySys_SetObject("__stderr__", std) < 0) {
1953 Py_DECREF(std);
1954 goto error;
1955 }
1956 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
1957 Py_DECREF(std);
1958 goto error;
1959 }
1960 Py_DECREF(std);
1961#endif
1962
Victor Stinnera7368ac2017-11-15 18:11:45 -08001963 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10001964
Victor Stinnera7368ac2017-11-15 18:11:45 -08001965error:
Victor Stinner331a6a52019-05-27 16:39:22 +02001966 res = _PyStatus_ERR("can't initialize sys standard streams");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001967
1968done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02001969 _Py_ClearStandardStreamEncoding();
Victor Stinner31e99082017-12-20 23:41:38 +01001970
Nick Coghland6009512014-11-20 21:39:37 +10001971 Py_XDECREF(bimod);
1972 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001973 return res;
Nick Coghland6009512014-11-20 21:39:37 +10001974}
1975
1976
Victor Stinner10dc4842015-03-24 12:01:30 +01001977static void
Victor Stinner47bbab92019-09-18 14:10:16 +02001978_Py_FatalError_DumpTracebacks(int fd, PyInterpreterState *interp,
1979 PyThreadState *tstate)
Victor Stinner10dc4842015-03-24 12:01:30 +01001980{
Victor Stinner10dc4842015-03-24 12:01:30 +01001981 fputc('\n', stderr);
1982 fflush(stderr);
1983
1984 /* display the current Python stack */
Victor Stinner47bbab92019-09-18 14:10:16 +02001985 _Py_DumpTracebackThreads(fd, interp, tstate);
Victor Stinner10dc4842015-03-24 12:01:30 +01001986}
Victor Stinner791da1c2016-03-14 16:53:12 +01001987
1988/* Print the current exception (if an exception is set) with its traceback,
1989 or display the current Python stack.
1990
1991 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
1992 called on catastrophic cases.
1993
1994 Return 1 if the traceback was displayed, 0 otherwise. */
1995
1996static int
1997_Py_FatalError_PrintExc(int fd)
1998{
1999 PyObject *ferr, *res;
2000 PyObject *exception, *v, *tb;
2001 int has_tb;
2002
Victor Stinner791da1c2016-03-14 16:53:12 +01002003 PyErr_Fetch(&exception, &v, &tb);
2004 if (exception == NULL) {
2005 /* No current exception */
2006 return 0;
2007 }
2008
2009 ferr = _PySys_GetObjectId(&PyId_stderr);
2010 if (ferr == NULL || ferr == Py_None) {
2011 /* sys.stderr is not set yet or set to None,
2012 no need to try to display the exception */
2013 return 0;
2014 }
2015
2016 PyErr_NormalizeException(&exception, &v, &tb);
2017 if (tb == NULL) {
2018 tb = Py_None;
2019 Py_INCREF(tb);
2020 }
2021 PyException_SetTraceback(v, tb);
2022 if (exception == NULL) {
2023 /* PyErr_NormalizeException() failed */
2024 return 0;
2025 }
2026
2027 has_tb = (tb != Py_None);
2028 PyErr_Display(exception, v, tb);
2029 Py_XDECREF(exception);
2030 Py_XDECREF(v);
2031 Py_XDECREF(tb);
2032
2033 /* sys.stderr may be buffered: call sys.stderr.flush() */
Victor Stinner3466bde2016-09-05 18:16:01 -07002034 res = _PyObject_CallMethodId(ferr, &PyId_flush, NULL);
Victor Stinner791da1c2016-03-14 16:53:12 +01002035 if (res == NULL)
2036 PyErr_Clear();
2037 else
2038 Py_DECREF(res);
2039
2040 return has_tb;
2041}
2042
Nick Coghland6009512014-11-20 21:39:37 +10002043/* Print fatal error message and abort */
2044
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002045#ifdef MS_WINDOWS
2046static void
2047fatal_output_debug(const char *msg)
2048{
2049 /* buffer of 256 bytes allocated on the stack */
2050 WCHAR buffer[256 / sizeof(WCHAR)];
2051 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2052 size_t msglen;
2053
2054 OutputDebugStringW(L"Fatal Python error: ");
2055
2056 msglen = strlen(msg);
2057 while (msglen) {
2058 size_t i;
2059
2060 if (buflen > msglen) {
2061 buflen = msglen;
2062 }
2063
2064 /* Convert the message to wchar_t. This uses a simple one-to-one
2065 conversion, assuming that the this error message actually uses
2066 ASCII only. If this ceases to be true, we will have to convert. */
2067 for (i=0; i < buflen; ++i) {
2068 buffer[i] = msg[i];
2069 }
2070 buffer[i] = L'\0';
2071 OutputDebugStringW(buffer);
2072
2073 msg += buflen;
2074 msglen -= buflen;
2075 }
2076 OutputDebugStringW(L"\n");
2077}
2078#endif
2079
Victor Stinner47bbab92019-09-18 14:10:16 +02002080
2081static void
2082fatal_error_dump_runtime(FILE *stream, _PyRuntimeState *runtime)
2083{
2084 fprintf(stream, "Python runtime state: ");
2085 if (runtime->finalizing) {
2086 fprintf(stream, "finalizing (tstate=%p)", runtime->finalizing);
2087 }
2088 else if (runtime->initialized) {
2089 fprintf(stream, "initialized");
2090 }
2091 else if (runtime->core_initialized) {
2092 fprintf(stream, "core initialized");
2093 }
2094 else if (runtime->preinitialized) {
2095 fprintf(stream, "preinitialized");
2096 }
2097 else if (runtime->preinitializing) {
2098 fprintf(stream, "preinitializing");
2099 }
2100 else {
2101 fprintf(stream, "unknown");
2102 }
2103 fprintf(stream, "\n");
2104 fflush(stream);
2105}
2106
2107
Benjamin Petersoncef88b92017-11-25 13:02:55 -08002108static void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002109fatal_error(const char *prefix, const char *msg, int status)
Nick Coghland6009512014-11-20 21:39:37 +10002110{
Victor Stinner47bbab92019-09-18 14:10:16 +02002111 FILE *stream = stderr;
2112 const int fd = fileno(stream);
Victor Stinner53345a42015-03-25 01:55:14 +01002113 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002114
2115 if (reentrant) {
2116 /* Py_FatalError() caused a second fatal error.
2117 Example: flush_std_files() raises a recursion error. */
2118 goto exit;
2119 }
2120 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002121
Victor Stinner47bbab92019-09-18 14:10:16 +02002122 fprintf(stream, "Fatal Python error: ");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002123 if (prefix) {
Victor Stinner47bbab92019-09-18 14:10:16 +02002124 fputs(prefix, stream);
2125 fputs(": ", stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002126 }
2127 if (msg) {
Victor Stinner47bbab92019-09-18 14:10:16 +02002128 fputs(msg, stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002129 }
2130 else {
Victor Stinner47bbab92019-09-18 14:10:16 +02002131 fprintf(stream, "<message not set>");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002132 }
Victor Stinner47bbab92019-09-18 14:10:16 +02002133 fputs("\n", stream);
2134 fflush(stream); /* it helps in Windows debug build */
2135
2136 _PyRuntimeState *runtime = &_PyRuntime;
2137 fatal_error_dump_runtime(stream, runtime);
2138
2139 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
2140 PyInterpreterState *interp = NULL;
2141 if (tstate != NULL) {
2142 interp = tstate->interp;
2143 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002144
Victor Stinner3a228ab2018-11-01 00:26:41 +01002145 /* Check if the current thread has a Python thread state
Victor Stinner47bbab92019-09-18 14:10:16 +02002146 and holds the GIL.
Victor Stinner3a228ab2018-11-01 00:26:41 +01002147
Victor Stinner47bbab92019-09-18 14:10:16 +02002148 tss_tstate is NULL if Py_FatalError() is called from a C thread which
2149 has no Python thread state.
2150
2151 tss_tstate != tstate if the current Python thread does not hold the GIL.
2152 */
2153 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2154 int has_tstate_and_gil = (tss_tstate != NULL && tss_tstate == tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002155 if (has_tstate_and_gil) {
2156 /* If an exception is set, print the exception with its traceback */
2157 if (!_Py_FatalError_PrintExc(fd)) {
2158 /* No exception is set, or an exception is set without traceback */
Victor Stinner47bbab92019-09-18 14:10:16 +02002159 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002160 }
2161 }
2162 else {
Victor Stinner47bbab92019-09-18 14:10:16 +02002163 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002164 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002165
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002166 /* The main purpose of faulthandler is to display the traceback.
2167 This function already did its best to display a traceback.
2168 Disable faulthandler to prevent writing a second traceback
2169 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002170 _PyFaulthandler_Fini();
2171
Victor Stinner791da1c2016-03-14 16:53:12 +01002172 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002173 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002174 /* Flush sys.stdout and sys.stderr */
2175 flush_std_files();
2176 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002177
Nick Coghland6009512014-11-20 21:39:37 +10002178#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002179 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002180#endif /* MS_WINDOWS */
2181
2182exit:
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002183 if (status < 0) {
Victor Stinner53345a42015-03-25 01:55:14 +01002184#if defined(MS_WINDOWS) && defined(_DEBUG)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002185 DebugBreak();
Nick Coghland6009512014-11-20 21:39:37 +10002186#endif
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002187 abort();
2188 }
2189 else {
2190 exit(status);
2191 }
2192}
2193
Victor Stinner19760862017-12-20 01:41:59 +01002194void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002195Py_FatalError(const char *msg)
2196{
2197 fatal_error(NULL, msg, -1);
2198}
2199
Victor Stinner19760862017-12-20 01:41:59 +01002200void _Py_NO_RETURN
Victor Stinner331a6a52019-05-27 16:39:22 +02002201Py_ExitStatusException(PyStatus status)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002202{
Victor Stinner331a6a52019-05-27 16:39:22 +02002203 if (_PyStatus_IS_EXIT(status)) {
2204 exit(status.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002205 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002206 else if (_PyStatus_IS_ERROR(status)) {
2207 fatal_error(status.func, status.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002208 }
2209 else {
Victor Stinner331a6a52019-05-27 16:39:22 +02002210 Py_FatalError("Py_ExitStatusException() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002211 }
Nick Coghland6009512014-11-20 21:39:37 +10002212}
2213
2214/* Clean up and exit */
2215
Victor Stinnerd7292b52016-06-17 12:29:00 +02002216# include "pythread.h"
Nick Coghland6009512014-11-20 21:39:37 +10002217
Nick Coghland6009512014-11-20 21:39:37 +10002218/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002219void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002220{
Victor Stinnercaba55b2018-08-03 15:33:52 +02002221 PyInterpreterState *is = _PyInterpreterState_Get();
Marcel Plch776407f2017-12-20 11:17:58 +01002222
Antoine Pitroufc5db952017-12-13 02:29:07 +01002223 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002224 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2225
2226 is->pyexitfunc = func;
2227 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002228}
2229
2230static void
Marcel Plch776407f2017-12-20 11:17:58 +01002231call_py_exitfuncs(PyInterpreterState *istate)
Nick Coghland6009512014-11-20 21:39:37 +10002232{
Marcel Plch776407f2017-12-20 11:17:58 +01002233 if (istate->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002234 return;
2235
Marcel Plch776407f2017-12-20 11:17:58 +01002236 (*istate->pyexitfunc)(istate->pyexitmodule);
Nick Coghland6009512014-11-20 21:39:37 +10002237 PyErr_Clear();
2238}
2239
2240/* Wait until threading._shutdown completes, provided
2241 the threading module was imported in the first place.
2242 The shutdown routine will wait until all non-daemon
2243 "threading" threads have completed. */
2244static void
2245wait_for_thread_shutdown(void)
2246{
Nick Coghland6009512014-11-20 21:39:37 +10002247 _Py_IDENTIFIER(_shutdown);
2248 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002249 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002250 if (threading == NULL) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002251 if (PyErr_Occurred()) {
2252 PyErr_WriteUnraisable(NULL);
2253 }
2254 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002255 return;
2256 }
Victor Stinner3466bde2016-09-05 18:16:01 -07002257 result = _PyObject_CallMethodId(threading, &PyId__shutdown, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10002258 if (result == NULL) {
2259 PyErr_WriteUnraisable(threading);
2260 }
2261 else {
2262 Py_DECREF(result);
2263 }
2264 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002265}
2266
2267#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002268int Py_AtExit(void (*func)(void))
2269{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002270 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002271 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002272 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002273 return 0;
2274}
2275
2276static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002277call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002278{
Victor Stinner8e91c242019-04-24 17:24:01 +02002279 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002280 /* pop last function from the list */
2281 runtime->nexitfuncs--;
2282 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2283 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2284
2285 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002286 }
Nick Coghland6009512014-11-20 21:39:37 +10002287
2288 fflush(stdout);
2289 fflush(stderr);
2290}
2291
Victor Stinnercfc88312018-08-01 16:41:25 +02002292void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002293Py_Exit(int sts)
2294{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002295 if (Py_FinalizeEx() < 0) {
2296 sts = 120;
2297 }
Nick Coghland6009512014-11-20 21:39:37 +10002298
2299 exit(sts);
2300}
2301
Victor Stinner331a6a52019-05-27 16:39:22 +02002302static PyStatus
Victor Stinner43fc3bb2019-05-02 11:54:20 -04002303init_signals(void)
Nick Coghland6009512014-11-20 21:39:37 +10002304{
2305#ifdef SIGPIPE
2306 PyOS_setsig(SIGPIPE, SIG_IGN);
2307#endif
2308#ifdef SIGXFZ
2309 PyOS_setsig(SIGXFZ, SIG_IGN);
2310#endif
2311#ifdef SIGXFSZ
2312 PyOS_setsig(SIGXFSZ, SIG_IGN);
2313#endif
2314 PyOS_InitInterrupts(); /* May imply initsignal() */
2315 if (PyErr_Occurred()) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002316 return _PyStatus_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002317 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002318 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002319}
2320
2321
2322/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2323 *
2324 * All of the code in this function must only use async-signal-safe functions,
2325 * listed at `man 7 signal` or
2326 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2327 */
2328void
2329_Py_RestoreSignals(void)
2330{
2331#ifdef SIGPIPE
2332 PyOS_setsig(SIGPIPE, SIG_DFL);
2333#endif
2334#ifdef SIGXFZ
2335 PyOS_setsig(SIGXFZ, SIG_DFL);
2336#endif
2337#ifdef SIGXFSZ
2338 PyOS_setsig(SIGXFSZ, SIG_DFL);
2339#endif
2340}
2341
2342
2343/*
2344 * The file descriptor fd is considered ``interactive'' if either
2345 * a) isatty(fd) is TRUE, or
2346 * b) the -i flag was given, and the filename associated with
2347 * the descriptor is NULL or "<stdin>" or "???".
2348 */
2349int
2350Py_FdIsInteractive(FILE *fp, const char *filename)
2351{
2352 if (isatty((int)fileno(fp)))
2353 return 1;
2354 if (!Py_InteractiveFlag)
2355 return 0;
2356 return (filename == NULL) ||
2357 (strcmp(filename, "<stdin>") == 0) ||
2358 (strcmp(filename, "???") == 0);
2359}
2360
2361
Nick Coghland6009512014-11-20 21:39:37 +10002362/* Wrappers around sigaction() or signal(). */
2363
2364PyOS_sighandler_t
2365PyOS_getsig(int sig)
2366{
2367#ifdef HAVE_SIGACTION
2368 struct sigaction context;
2369 if (sigaction(sig, NULL, &context) == -1)
2370 return SIG_ERR;
2371 return context.sa_handler;
2372#else
2373 PyOS_sighandler_t handler;
2374/* Special signal handling for the secure CRT in Visual Studio 2005 */
2375#if defined(_MSC_VER) && _MSC_VER >= 1400
2376 switch (sig) {
2377 /* Only these signals are valid */
2378 case SIGINT:
2379 case SIGILL:
2380 case SIGFPE:
2381 case SIGSEGV:
2382 case SIGTERM:
2383 case SIGBREAK:
2384 case SIGABRT:
2385 break;
2386 /* Don't call signal() with other values or it will assert */
2387 default:
2388 return SIG_ERR;
2389 }
2390#endif /* _MSC_VER && _MSC_VER >= 1400 */
2391 handler = signal(sig, SIG_IGN);
2392 if (handler != SIG_ERR)
2393 signal(sig, handler);
2394 return handler;
2395#endif
2396}
2397
2398/*
2399 * All of the code in this function must only use async-signal-safe functions,
2400 * listed at `man 7 signal` or
2401 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2402 */
2403PyOS_sighandler_t
2404PyOS_setsig(int sig, PyOS_sighandler_t handler)
2405{
2406#ifdef HAVE_SIGACTION
2407 /* Some code in Modules/signalmodule.c depends on sigaction() being
2408 * used here if HAVE_SIGACTION is defined. Fix that if this code
2409 * changes to invalidate that assumption.
2410 */
2411 struct sigaction context, ocontext;
2412 context.sa_handler = handler;
2413 sigemptyset(&context.sa_mask);
2414 context.sa_flags = 0;
2415 if (sigaction(sig, &context, &ocontext) == -1)
2416 return SIG_ERR;
2417 return ocontext.sa_handler;
2418#else
2419 PyOS_sighandler_t oldhandler;
2420 oldhandler = signal(sig, handler);
2421#ifdef HAVE_SIGINTERRUPT
2422 siginterrupt(sig, 1);
2423#endif
2424 return oldhandler;
2425#endif
2426}
2427
2428#ifdef __cplusplus
2429}
2430#endif