blob: 751c4d6d1d631cfe8dcdd88ec065b6120c883b6f [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) {
475 status = _PyConfig_SetPathConfig(config);
476 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 Stinner331a6a52019-05-27 16:39:22 +0200626 PyStatus status = _PyImport_Init(interp);
627 if (_PyStatus_EXCEPTION(status)) {
628 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800629 }
Nick Coghland6009512014-11-20 21:39:37 +1000630
Victor Stinner331a6a52019-05-27 16:39:22 +0200631 status = _PyImportHooks_Init();
632 if (_PyStatus_EXCEPTION(status)) {
633 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800634 }
Nick Coghland6009512014-11-20 21:39:37 +1000635
636 /* Initialize _warnings. */
Victor Stinner5d862462017-12-19 11:35:58 +0100637 if (_PyWarnings_Init() == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200638 return _PyStatus_ERR("can't initialize warnings");
Victor Stinner1f151112017-11-23 10:43:14 +0100639 }
Nick Coghland6009512014-11-20 21:39:37 +1000640
Victor Stinner331a6a52019-05-27 16:39:22 +0200641 if (interp->config._install_importlib) {
642 status = _PyConfig_SetPathConfig(&interp->config);
643 if (_PyStatus_EXCEPTION(status)) {
644 return status;
Victor Stinnerb1147e42018-07-21 02:06:16 +0200645 }
646 }
647
Eric Snow1abcf672017-05-23 21:46:51 -0700648 /* This call sets up builtin and frozen import support */
Victor Stinner331a6a52019-05-27 16:39:22 +0200649 if (interp->config._install_importlib) {
650 status = init_importlib(interp, sysmod);
651 if (_PyStatus_EXCEPTION(status)) {
652 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800653 }
Eric Snow1abcf672017-05-23 21:46:51 -0700654 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200655 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100656}
657
658
Victor Stinner331a6a52019-05-27 16:39:22 +0200659static PyStatus
660pyinit_config(_PyRuntimeState *runtime,
661 PyInterpreterState **interp_p,
662 const PyConfig *config)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100663{
664 PyInterpreterState *interp;
665
Victor Stinner331a6a52019-05-27 16:39:22 +0200666 _PyConfig_Write(config, runtime);
Victor Stinner20004952019-03-26 02:31:11 +0100667
Victor Stinner331a6a52019-05-27 16:39:22 +0200668 PyStatus status = pycore_init_runtime(runtime, config);
669 if (_PyStatus_EXCEPTION(status)) {
670 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100671 }
672
Victor Stinner331a6a52019-05-27 16:39:22 +0200673 status = pycore_create_interpreter(runtime, config, &interp);
674 if (_PyStatus_EXCEPTION(status)) {
675 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100676 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200677 config = &interp->config;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100678 *interp_p = interp;
679
Victor Stinner331a6a52019-05-27 16:39:22 +0200680 status = pycore_init_types();
681 if (_PyStatus_EXCEPTION(status)) {
682 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100683 }
684
685 PyObject *sysmod;
Victor Stinner0fd2c302019-06-04 03:15:09 +0200686 status = _PySys_Create(runtime, interp, &sysmod);
Victor Stinner331a6a52019-05-27 16:39:22 +0200687 if (_PyStatus_EXCEPTION(status)) {
688 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100689 }
690
Victor Stinner331a6a52019-05-27 16:39:22 +0200691 status = pycore_init_builtins(interp);
692 if (_PyStatus_EXCEPTION(status)) {
693 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100694 }
695
Victor Stinner331a6a52019-05-27 16:39:22 +0200696 status = pycore_init_import_warnings(interp, sysmod);
697 if (_PyStatus_EXCEPTION(status)) {
698 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100699 }
Eric Snow1abcf672017-05-23 21:46:51 -0700700
701 /* Only when we get here is the runtime core fully initialized */
Victor Stinner43125222019-04-24 18:23:53 +0200702 runtime->core_initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200703 return _PyStatus_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700704}
705
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100706
Victor Stinner331a6a52019-05-27 16:39:22 +0200707PyStatus
708_Py_PreInitializeFromPyArgv(const PyPreConfig *src_config, const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100709{
Victor Stinner331a6a52019-05-27 16:39:22 +0200710 PyStatus status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100711
Victor Stinner6d1c4672019-05-20 11:02:00 +0200712 if (src_config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200713 return _PyStatus_ERR("preinitialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +0200714 }
715
Victor Stinner331a6a52019-05-27 16:39:22 +0200716 status = _PyRuntime_Initialize();
717 if (_PyStatus_EXCEPTION(status)) {
718 return status;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100719 }
Victor Stinner43125222019-04-24 18:23:53 +0200720 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100721
Victor Stinner43125222019-04-24 18:23:53 +0200722 if (runtime->pre_initialized) {
Victor Stinnerf72346c2019-03-25 17:54:58 +0100723 /* If it's already configured: ignored the new configuration */
Victor Stinner331a6a52019-05-27 16:39:22 +0200724 return _PyStatus_OK();
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100725 }
726
Victor Stinner331a6a52019-05-27 16:39:22 +0200727 PyPreConfig config;
Victor Stinner6d1c4672019-05-20 11:02:00 +0200728 _PyPreConfig_InitFromPreConfig(&config, src_config);
Victor Stinnerf72346c2019-03-25 17:54:58 +0100729
Victor Stinner331a6a52019-05-27 16:39:22 +0200730 status = _PyPreConfig_Read(&config, args);
731 if (_PyStatus_EXCEPTION(status)) {
732 return status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100733 }
734
Victor Stinner331a6a52019-05-27 16:39:22 +0200735 status = _PyPreConfig_Write(&config);
736 if (_PyStatus_EXCEPTION(status)) {
737 return status;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100738 }
739
Victor Stinner43125222019-04-24 18:23:53 +0200740 runtime->pre_initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200741 return _PyStatus_OK();
Victor Stinnerf72346c2019-03-25 17:54:58 +0100742}
743
Victor Stinner70005ac2019-05-02 15:25:34 -0400744
Victor Stinner331a6a52019-05-27 16:39:22 +0200745PyStatus
746Py_PreInitializeFromBytesArgs(const PyPreConfig *src_config, Py_ssize_t argc, char **argv)
Victor Stinnerf72346c2019-03-25 17:54:58 +0100747{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100748 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400749 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100750}
751
752
Victor Stinner331a6a52019-05-27 16:39:22 +0200753PyStatus
754Py_PreInitializeFromArgs(const PyPreConfig *src_config, Py_ssize_t argc, wchar_t **argv)
Victor Stinner20004952019-03-26 02:31:11 +0100755{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100756 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400757 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinner20004952019-03-26 02:31:11 +0100758}
759
760
Victor Stinner331a6a52019-05-27 16:39:22 +0200761PyStatus
762Py_PreInitialize(const PyPreConfig *src_config)
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100763{
Victor Stinner70005ac2019-05-02 15:25:34 -0400764 return _Py_PreInitializeFromPyArgv(src_config, NULL);
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100765}
766
767
Victor Stinner331a6a52019-05-27 16:39:22 +0200768PyStatus
769_Py_PreInitializeFromConfig(const PyConfig *config,
770 const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100771{
Victor Stinner331a6a52019-05-27 16:39:22 +0200772 assert(config != NULL);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200773
Victor Stinner331a6a52019-05-27 16:39:22 +0200774 PyStatus status = _PyRuntime_Initialize();
775 if (_PyStatus_EXCEPTION(status)) {
776 return status;
Victor Stinner6d1c4672019-05-20 11:02:00 +0200777 }
778 _PyRuntimeState *runtime = &_PyRuntime;
779
780 if (runtime->pre_initialized) {
781 /* Already initialized: do nothing */
Victor Stinner331a6a52019-05-27 16:39:22 +0200782 return _PyStatus_OK();
Victor Stinner70005ac2019-05-02 15:25:34 -0400783 }
Victor Stinnercab5d072019-05-17 19:01:14 +0200784
Victor Stinner331a6a52019-05-27 16:39:22 +0200785 PyPreConfig preconfig;
786 _PyPreConfig_InitFromConfig(&preconfig, config);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200787
Victor Stinner331a6a52019-05-27 16:39:22 +0200788 if (!config->parse_argv) {
789 return Py_PreInitialize(&preconfig);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200790 }
791 else if (args == NULL) {
Victor Stinnercab5d072019-05-17 19:01:14 +0200792 _PyArgv config_args = {
793 .use_bytes_argv = 0,
Victor Stinner331a6a52019-05-27 16:39:22 +0200794 .argc = config->argv.length,
795 .wchar_argv = config->argv.items};
Victor Stinner6d1c4672019-05-20 11:02:00 +0200796 return _Py_PreInitializeFromPyArgv(&preconfig, &config_args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200797 }
798 else {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200799 return _Py_PreInitializeFromPyArgv(&preconfig, args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200800 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100801}
802
803
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100804/* Begin interpreter initialization
805 *
806 * On return, the first thread and interpreter state have been created,
807 * but the compiler, signal handling, multithreading and
808 * multiple interpreter support, and codec infrastructure are not yet
809 * available.
810 *
811 * The import system will support builtin and frozen modules only.
812 * The only supported io is writing to sys.stderr
813 *
814 * If any operation invoked by this function fails, a fatal error is
815 * issued and the function does not return.
816 *
817 * Any code invoked from this function should *not* assume it has access
818 * to the Python C API (unless the API is explicitly listed as being
819 * safe to call without calling Py_Initialize first)
820 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200821static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200822pyinit_core(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200823 const PyConfig *src_config,
Victor Stinner5edcf262019-05-23 00:57:57 +0200824 PyInterpreterState **interp_p)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200825{
Victor Stinner331a6a52019-05-27 16:39:22 +0200826 PyStatus status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200827
Victor Stinner331a6a52019-05-27 16:39:22 +0200828 status = _Py_PreInitializeFromConfig(src_config, NULL);
829 if (_PyStatus_EXCEPTION(status)) {
830 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200831 }
832
Victor Stinner331a6a52019-05-27 16:39:22 +0200833 PyConfig config;
834 _PyConfig_InitCompatConfig(&config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200835
Victor Stinner331a6a52019-05-27 16:39:22 +0200836 status = _PyConfig_Copy(&config, src_config);
837 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200838 goto done;
839 }
840
Victor Stinner331a6a52019-05-27 16:39:22 +0200841 status = PyConfig_Read(&config);
842 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200843 goto done;
844 }
845
846 if (!runtime->core_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200847 status = pyinit_config(runtime, interp_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200848 }
849 else {
Victor Stinner331a6a52019-05-27 16:39:22 +0200850 status = pyinit_core_reconfigure(runtime, interp_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200851 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200852 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200853 goto done;
854 }
855
856done:
Victor Stinner331a6a52019-05-27 16:39:22 +0200857 PyConfig_Clear(&config);
858 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200859}
860
Victor Stinner5ac27a52019-03-27 13:40:14 +0100861
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200862/* Py_Initialize() has already been called: update the main interpreter
863 configuration. Example of bpo-34008: Py_Main() called after
864 Py_Initialize(). */
Victor Stinner331a6a52019-05-27 16:39:22 +0200865static PyStatus
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100866_Py_ReconfigureMainInterpreter(PyInterpreterState *interp)
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200867{
Victor Stinner331a6a52019-05-27 16:39:22 +0200868 PyConfig *config = &interp->config;
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100869
Victor Stinner331a6a52019-05-27 16:39:22 +0200870 PyObject *argv = _PyWideStringList_AsList(&config->argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100871 if (argv == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200872 return _PyStatus_NO_MEMORY(); \
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100873 }
874
875 int res = PyDict_SetItemString(interp->sysdict, "argv", argv);
876 Py_DECREF(argv);
877 if (res < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200878 return _PyStatus_ERR("fail to set sys.argv");
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200879 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200880 return _PyStatus_OK();
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200881}
882
Eric Snowc7ec9982017-05-23 23:00:52 -0700883/* Update interpreter state based on supplied configuration settings
884 *
885 * After calling this function, most of the restrictions on the interpreter
886 * are lifted. The only remaining incomplete settings are those related
887 * to the main module (sys.argv[0], __main__ metadata)
888 *
889 * Calling this when the interpreter is not initializing, is already
890 * initialized or without a valid current thread state is a fatal error.
891 * Other errors should be reported as normal Python exceptions with a
892 * non-zero return code.
893 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200894static PyStatus
Victor Stinner0fd2c302019-06-04 03:15:09 +0200895pyinit_main(_PyRuntimeState *runtime, PyInterpreterState *interp)
Eric Snow1abcf672017-05-23 21:46:51 -0700896{
Victor Stinner43125222019-04-24 18:23:53 +0200897 if (!runtime->core_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200898 return _PyStatus_ERR("runtime core not initialized");
Eric Snowc7ec9982017-05-23 23:00:52 -0700899 }
Eric Snowc7ec9982017-05-23 23:00:52 -0700900
Victor Stinner1dc6e392018-07-25 02:49:17 +0200901 /* Configure the main interpreter */
Victor Stinner331a6a52019-05-27 16:39:22 +0200902 PyConfig *config = &interp->config;
Eric Snowc7ec9982017-05-23 23:00:52 -0700903
Victor Stinner43125222019-04-24 18:23:53 +0200904 if (runtime->initialized) {
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100905 return _Py_ReconfigureMainInterpreter(interp);
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200906 }
907
Victor Stinner331a6a52019-05-27 16:39:22 +0200908 if (!config->_install_importlib) {
Eric Snow1abcf672017-05-23 21:46:51 -0700909 /* Special mode for freeze_importlib: run with no import system
910 *
911 * This means anything which needs support from extension modules
912 * or pure Python code in the standard library won't work.
913 */
Victor Stinner43125222019-04-24 18:23:53 +0200914 runtime->initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200915 return _PyStatus_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700916 }
Victor Stinner9316ee42017-11-25 03:17:57 +0100917
Victor Stinner33c377e2017-12-05 15:12:41 +0100918 if (_PyTime_Init() < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200919 return _PyStatus_ERR("can't initialize time");
Victor Stinner33c377e2017-12-05 15:12:41 +0100920 }
Victor Stinner13019fd2015-04-03 13:10:54 +0200921
Victor Stinner0fd2c302019-06-04 03:15:09 +0200922 if (_PySys_InitMain(runtime, interp) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200923 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerda273412017-12-15 01:46:02 +0100924 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800925
Victor Stinner331a6a52019-05-27 16:39:22 +0200926 PyStatus status = init_importlib_external(interp);
927 if (_PyStatus_EXCEPTION(status)) {
928 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800929 }
Nick Coghland6009512014-11-20 21:39:37 +1000930
931 /* initialize the faulthandler module */
Victor Stinner331a6a52019-05-27 16:39:22 +0200932 status = _PyFaulthandler_Init(config->faulthandler);
933 if (_PyStatus_EXCEPTION(status)) {
934 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800935 }
Nick Coghland6009512014-11-20 21:39:37 +1000936
Victor Stinner331a6a52019-05-27 16:39:22 +0200937 status = _PyUnicode_InitEncodings(interp);
938 if (_PyStatus_EXCEPTION(status)) {
939 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800940 }
Nick Coghland6009512014-11-20 21:39:37 +1000941
Victor Stinner331a6a52019-05-27 16:39:22 +0200942 if (config->install_signal_handlers) {
943 status = init_signals();
944 if (_PyStatus_EXCEPTION(status)) {
945 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800946 }
947 }
Nick Coghland6009512014-11-20 21:39:37 +1000948
Victor Stinner331a6a52019-05-27 16:39:22 +0200949 if (_PyTraceMalloc_Init(config->tracemalloc) < 0) {
950 return _PyStatus_ERR("can't initialize tracemalloc");
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200951 }
Nick Coghland6009512014-11-20 21:39:37 +1000952
Victor Stinner331a6a52019-05-27 16:39:22 +0200953 status = add_main_module(interp);
954 if (_PyStatus_EXCEPTION(status)) {
955 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800956 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800957
Victor Stinner331a6a52019-05-27 16:39:22 +0200958 status = init_sys_streams(interp);
959 if (_PyStatus_EXCEPTION(status)) {
960 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800961 }
Nick Coghland6009512014-11-20 21:39:37 +1000962
963 /* Initialize warnings. */
Victor Stinner37cd9822018-11-16 11:55:35 +0100964 PyObject *warnoptions = PySys_GetObject("warnoptions");
965 if (warnoptions != NULL && PyList_Size(warnoptions) > 0)
Victor Stinner5d862462017-12-19 11:35:58 +0100966 {
Nick Coghland6009512014-11-20 21:39:37 +1000967 PyObject *warnings_module = PyImport_ImportModule("warnings");
968 if (warnings_module == NULL) {
969 fprintf(stderr, "'import warnings' failed; traceback:\n");
970 PyErr_Print();
971 }
972 Py_XDECREF(warnings_module);
973 }
974
Victor Stinner43125222019-04-24 18:23:53 +0200975 runtime->initialized = 1;
Eric Snow1abcf672017-05-23 21:46:51 -0700976
Victor Stinner331a6a52019-05-27 16:39:22 +0200977 if (config->site_import) {
978 status = init_import_size(); /* Module site */
979 if (_PyStatus_EXCEPTION(status)) {
980 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800981 }
982 }
Victor Stinnercf215042018-08-29 22:56:06 +0200983
984#ifndef MS_WINDOWS
Victor Stinner43125222019-04-24 18:23:53 +0200985 emit_stderr_warning_for_legacy_locale(runtime);
Victor Stinnercf215042018-08-29 22:56:06 +0200986#endif
987
Victor Stinner331a6a52019-05-27 16:39:22 +0200988 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000989}
990
Victor Stinner9ef5dca2019-05-16 17:38:16 +0200991
Victor Stinner331a6a52019-05-27 16:39:22 +0200992PyStatus
Victor Stinner9ef5dca2019-05-16 17:38:16 +0200993_Py_InitializeMain(void)
994{
Victor Stinner331a6a52019-05-27 16:39:22 +0200995 PyStatus status = _PyRuntime_Initialize();
996 if (_PyStatus_EXCEPTION(status)) {
997 return status;
Victor Stinner9ef5dca2019-05-16 17:38:16 +0200998 }
999 _PyRuntimeState *runtime = &_PyRuntime;
1000 PyInterpreterState *interp = _PyRuntimeState_GetThreadState(runtime)->interp;
1001
Victor Stinner0fd2c302019-06-04 03:15:09 +02001002 return pyinit_main(runtime, interp);
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001003}
1004
1005
Victor Stinner331a6a52019-05-27 16:39:22 +02001006PyStatus
1007Py_InitializeFromConfig(const PyConfig *config)
Eric Snow1abcf672017-05-23 21:46:51 -07001008{
Victor Stinner6d1c4672019-05-20 11:02:00 +02001009 if (config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001010 return _PyStatus_ERR("initialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +02001011 }
1012
Victor Stinner331a6a52019-05-27 16:39:22 +02001013 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001014
Victor Stinner331a6a52019-05-27 16:39:22 +02001015 status = _PyRuntime_Initialize();
1016 if (_PyStatus_EXCEPTION(status)) {
1017 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001018 }
1019 _PyRuntimeState *runtime = &_PyRuntime;
1020
1021 PyInterpreterState *interp = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001022 status = pyinit_core(runtime, config, &interp);
1023 if (_PyStatus_EXCEPTION(status)) {
1024 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001025 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001026 config = &interp->config;
Victor Stinnerbc8ac6b2017-11-30 18:03:55 +01001027
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001028 if (config->_init_main) {
Victor Stinner0fd2c302019-06-04 03:15:09 +02001029 status = pyinit_main(runtime, interp);
Victor Stinner331a6a52019-05-27 16:39:22 +02001030 if (_PyStatus_EXCEPTION(status)) {
1031 return status;
Victor Stinner484f20d2019-03-27 02:04:16 +01001032 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001033 }
Victor Stinner484f20d2019-03-27 02:04:16 +01001034
Victor Stinner331a6a52019-05-27 16:39:22 +02001035 return _PyStatus_OK();
Victor Stinner5ac27a52019-03-27 13:40:14 +01001036}
1037
1038
Eric Snow1abcf672017-05-23 21:46:51 -07001039void
Nick Coghland6009512014-11-20 21:39:37 +10001040Py_InitializeEx(int install_sigs)
1041{
Victor Stinner331a6a52019-05-27 16:39:22 +02001042 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001043
Victor Stinner331a6a52019-05-27 16:39:22 +02001044 status = _PyRuntime_Initialize();
1045 if (_PyStatus_EXCEPTION(status)) {
1046 Py_ExitStatusException(status);
Victor Stinner43125222019-04-24 18:23:53 +02001047 }
1048 _PyRuntimeState *runtime = &_PyRuntime;
1049
1050 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001051 /* bpo-33932: Calling Py_Initialize() twice does nothing. */
1052 return;
1053 }
1054
Victor Stinner331a6a52019-05-27 16:39:22 +02001055 PyConfig config;
1056 _PyConfig_InitCompatConfig(&config);
Victor Stinner1dc6e392018-07-25 02:49:17 +02001057 config.install_signal_handlers = install_sigs;
1058
Victor Stinner331a6a52019-05-27 16:39:22 +02001059 status = Py_InitializeFromConfig(&config);
1060 if (_PyStatus_EXCEPTION(status)) {
1061 Py_ExitStatusException(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001062 }
Nick Coghland6009512014-11-20 21:39:37 +10001063}
1064
1065void
1066Py_Initialize(void)
1067{
1068 Py_InitializeEx(1);
1069}
1070
1071
1072#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001073extern void _Py_dump_counts(FILE*);
Nick Coghland6009512014-11-20 21:39:37 +10001074#endif
1075
1076/* Flush stdout and stderr */
1077
1078static int
1079file_is_closed(PyObject *fobj)
1080{
1081 int r;
1082 PyObject *tmp = PyObject_GetAttrString(fobj, "closed");
1083 if (tmp == NULL) {
1084 PyErr_Clear();
1085 return 0;
1086 }
1087 r = PyObject_IsTrue(tmp);
1088 Py_DECREF(tmp);
1089 if (r < 0)
1090 PyErr_Clear();
1091 return r > 0;
1092}
1093
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001094static int
Nick Coghland6009512014-11-20 21:39:37 +10001095flush_std_files(void)
1096{
1097 PyObject *fout = _PySys_GetObjectId(&PyId_stdout);
1098 PyObject *ferr = _PySys_GetObjectId(&PyId_stderr);
1099 PyObject *tmp;
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001100 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001101
1102 if (fout != NULL && fout != Py_None && !file_is_closed(fout)) {
Victor Stinner3466bde2016-09-05 18:16:01 -07001103 tmp = _PyObject_CallMethodId(fout, &PyId_flush, NULL);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001104 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001105 PyErr_WriteUnraisable(fout);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001106 status = -1;
1107 }
Nick Coghland6009512014-11-20 21:39:37 +10001108 else
1109 Py_DECREF(tmp);
1110 }
1111
1112 if (ferr != NULL && ferr != Py_None && !file_is_closed(ferr)) {
Victor Stinner3466bde2016-09-05 18:16:01 -07001113 tmp = _PyObject_CallMethodId(ferr, &PyId_flush, NULL);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001114 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001115 PyErr_Clear();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001116 status = -1;
1117 }
Nick Coghland6009512014-11-20 21:39:37 +10001118 else
1119 Py_DECREF(tmp);
1120 }
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001121
1122 return status;
Nick Coghland6009512014-11-20 21:39:37 +10001123}
1124
1125/* Undo the effect of Py_Initialize().
1126
1127 Beware: if multiple interpreter and/or thread states exist, these
1128 are not wiped out; only the current thread and interpreter state
1129 are deleted. But since everything else is deleted, those other
1130 interpreter and thread states should no longer be used.
1131
1132 (XXX We should do better, e.g. wipe out all interpreters and
1133 threads.)
1134
1135 Locking: as above.
1136
1137*/
1138
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001139int
1140Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001141{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001142 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001143
Victor Stinner8e91c242019-04-24 17:24:01 +02001144 _PyRuntimeState *runtime = &_PyRuntime;
1145 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001146 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001147 }
Nick Coghland6009512014-11-20 21:39:37 +10001148
Eric Snow842a2f02019-03-15 15:47:51 -06001149 // Wrap up existing "threading"-module-created, non-daemon threads.
Nick Coghland6009512014-11-20 21:39:37 +10001150 wait_for_thread_shutdown();
1151
Eric Snow842a2f02019-03-15 15:47:51 -06001152 // Make any remaining pending calls.
Victor Stinnere225beb2019-06-03 18:14:24 +02001153 _Py_FinishPendingCalls(runtime);
1154
1155 /* Get current thread state and interpreter pointer */
1156 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
1157 PyInterpreterState *interp = tstate->interp;
Victor Stinner8e91c242019-04-24 17:24:01 +02001158
Nick Coghland6009512014-11-20 21:39:37 +10001159 /* The interpreter is still entirely intact at this point, and the
1160 * exit funcs may be relying on that. In particular, if some thread
1161 * or exit func is still waiting to do an import, the import machinery
1162 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001163 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001164 * Note that Threading.py uses an exit func to do a join on all the
1165 * threads created thru it, so this also protects pending imports in
1166 * the threads created via Threading.
1167 */
Nick Coghland6009512014-11-20 21:39:37 +10001168
Marcel Plch776407f2017-12-20 11:17:58 +01001169 call_py_exitfuncs(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001170
Victor Stinnerda273412017-12-15 01:46:02 +01001171 /* Copy the core config, PyInterpreterState_Delete() free
1172 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001173#ifdef Py_REF_DEBUG
Victor Stinner331a6a52019-05-27 16:39:22 +02001174 int show_ref_count = interp->config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001175#endif
1176#ifdef Py_TRACE_REFS
Victor Stinner331a6a52019-05-27 16:39:22 +02001177 int dump_refs = interp->config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001178#endif
1179#ifdef WITH_PYMALLOC
Victor Stinner331a6a52019-05-27 16:39:22 +02001180 int malloc_stats = interp->config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001181#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001182
Nick Coghland6009512014-11-20 21:39:37 +10001183 /* Remaining threads (e.g. daemon threads) will automatically exit
1184 after taking the GIL (in PyEval_RestoreThread()). */
Victor Stinner8e91c242019-04-24 17:24:01 +02001185 runtime->finalizing = tstate;
1186 runtime->initialized = 0;
1187 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001188
Victor Stinnere0deff32015-03-24 13:46:18 +01001189 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001190 if (flush_std_files() < 0) {
1191 status = -1;
1192 }
Nick Coghland6009512014-11-20 21:39:37 +10001193
1194 /* Disable signal handling */
1195 PyOS_FiniInterrupts();
1196
1197 /* Collect garbage. This may call finalizers; it's nice to call these
1198 * before all modules are destroyed.
1199 * XXX If a __del__ or weakref callback is triggered here, and tries to
1200 * XXX import a module, bad things can happen, because Python no
1201 * XXX longer believes it's initialized.
1202 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1203 * XXX is easy to provoke that way. I've also seen, e.g.,
1204 * XXX Exception exceptions.ImportError: 'No module named sha'
1205 * XXX in <function callback at 0x008F5718> ignored
1206 * XXX but I'm unclear on exactly how that one happens. In any case,
1207 * XXX I haven't seen a real-life report of either of these.
1208 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001209 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001210#ifdef COUNT_ALLOCS
1211 /* With COUNT_ALLOCS, it helps to run GC multiple times:
1212 each collection might release some types from the type
1213 list, so they become garbage. */
Łukasz Langafef7e942016-09-09 21:47:46 -07001214 while (_PyGC_CollectIfEnabled() > 0)
Nick Coghland6009512014-11-20 21:39:37 +10001215 /* nothing */;
1216#endif
Eric Snowdae02762017-09-14 00:35:58 -07001217
Steve Dowerb82e17e2019-05-23 08:45:22 -07001218 /* Clear all loghooks */
1219 /* We want minimal exposure of this function, so define the extern
1220 * here. The linker should discover the correct function without
1221 * exporting a symbol. */
1222 extern void _PySys_ClearAuditHooks(void);
1223 _PySys_ClearAuditHooks();
1224
Nick Coghland6009512014-11-20 21:39:37 +10001225 /* Destroy all modules */
1226 PyImport_Cleanup();
1227
Inada Naoki91234a12019-06-03 21:30:58 +09001228 /* Print debug stats if any */
1229 _PyEval_Fini();
1230
Victor Stinnere0deff32015-03-24 13:46:18 +01001231 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001232 if (flush_std_files() < 0) {
1233 status = -1;
1234 }
Nick Coghland6009512014-11-20 21:39:37 +10001235
1236 /* Collect final garbage. This disposes of cycles created by
1237 * class definitions, for example.
1238 * XXX This is disabled because it caused too many problems. If
1239 * XXX a __del__ or weakref callback triggers here, Python code has
1240 * XXX a hard time running, because even the sys module has been
1241 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1242 * XXX One symptom is a sequence of information-free messages
1243 * XXX coming from threads (if a __del__ or callback is invoked,
1244 * XXX other threads can execute too, and any exception they encounter
1245 * XXX triggers a comedy of errors as subsystem after subsystem
1246 * XXX fails to find what it *expects* to find in sys to help report
1247 * XXX the exception and consequent unexpected failures). I've also
1248 * XXX seen segfaults then, after adding print statements to the
1249 * XXX Python code getting called.
1250 */
1251#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001252 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001253#endif
1254
1255 /* Disable tracemalloc after all Python objects have been destroyed,
1256 so it is possible to use tracemalloc in objects destructor. */
1257 _PyTraceMalloc_Fini();
1258
1259 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1260 _PyImport_Fini();
1261
1262 /* Cleanup typeobject.c's internal caches. */
1263 _PyType_Fini();
1264
1265 /* unload faulthandler module */
1266 _PyFaulthandler_Fini();
1267
1268 /* Debugging stuff */
1269#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001270 _Py_dump_counts(stderr);
Nick Coghland6009512014-11-20 21:39:37 +10001271#endif
1272 /* dump hash stats */
1273 _PyHash_Fini();
1274
Eric Snowdae02762017-09-14 00:35:58 -07001275#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001276 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001277 _PyDebug_PrintTotalRefs();
1278 }
Eric Snowdae02762017-09-14 00:35:58 -07001279#endif
Nick Coghland6009512014-11-20 21:39:37 +10001280
1281#ifdef Py_TRACE_REFS
1282 /* Display all objects still alive -- this can invoke arbitrary
1283 * __repr__ overrides, so requires a mostly-intact interpreter.
1284 * Alas, a lot of stuff may still be alive now that will be cleaned
1285 * up later.
1286 */
Victor Stinnerda273412017-12-15 01:46:02 +01001287 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001288 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001289 }
Nick Coghland6009512014-11-20 21:39:37 +10001290#endif /* Py_TRACE_REFS */
1291
1292 /* Clear interpreter state and all thread states. */
1293 PyInterpreterState_Clear(interp);
1294
1295 /* Now we decref the exception classes. After this point nothing
1296 can raise an exception. That's okay, because each Fini() method
1297 below has been checked to make sure no exceptions are ever
1298 raised.
1299 */
1300
1301 _PyExc_Fini();
1302
1303 /* Sundry finalizers */
1304 PyMethod_Fini();
1305 PyFrame_Fini();
1306 PyCFunction_Fini();
1307 PyTuple_Fini();
1308 PyList_Fini();
1309 PySet_Fini();
1310 PyBytes_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001311 PyLong_Fini();
1312 PyFloat_Fini();
1313 PyDict_Fini();
1314 PySlice_Fini();
Victor Stinner8e91c242019-04-24 17:24:01 +02001315 _PyGC_Fini(runtime);
Eric Snow86ea5812019-05-10 13:29:55 -04001316 _PyWarnings_Fini(interp);
Eric Snow6b4be192017-05-22 21:36:03 -07001317 _Py_HashRandomization_Fini();
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001318 _PyArg_Fini();
Yury Selivanoveb636452016-09-08 22:01:51 -07001319 PyAsyncGen_Fini();
Yury Selivanovf23746a2018-01-22 19:11:18 -05001320 _PyContext_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001321
1322 /* Cleanup Unicode implementation */
1323 _PyUnicode_Fini();
1324
Victor Stinnerb2457ef2018-08-29 13:25:36 +02001325 _Py_ClearFileSystemEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10001326
1327 /* XXX Still allocated:
1328 - various static ad-hoc pointers to interned strings
1329 - int and float free list blocks
1330 - whatever various modules and libraries allocate
1331 */
1332
1333 PyGrammar_RemoveAccelerators(&_PyParser_Grammar);
1334
1335 /* Cleanup auto-thread-state */
Victor Stinner8e91c242019-04-24 17:24:01 +02001336 _PyGILState_Fini(runtime);
Nick Coghland6009512014-11-20 21:39:37 +10001337
1338 /* Delete current thread. After this, many C API calls become crashy. */
1339 PyThreadState_Swap(NULL);
Victor Stinner8a1be612016-03-14 22:07:55 +01001340
Nick Coghland6009512014-11-20 21:39:37 +10001341 PyInterpreterState_Delete(interp);
1342
1343#ifdef Py_TRACE_REFS
1344 /* Display addresses (& refcnts) of all objects still alive.
1345 * An address can be used to find the repr of the object, printed
1346 * above by _Py_PrintReferences.
1347 */
Victor Stinnerda273412017-12-15 01:46:02 +01001348 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001349 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001350 }
Nick Coghland6009512014-11-20 21:39:37 +10001351#endif /* Py_TRACE_REFS */
Victor Stinner34be8072016-03-14 12:04:26 +01001352#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001353 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001354 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be8072016-03-14 12:04:26 +01001355 }
Nick Coghland6009512014-11-20 21:39:37 +10001356#endif
1357
Victor Stinner8e91c242019-04-24 17:24:01 +02001358 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001359
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001360 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001361 return status;
1362}
1363
1364void
1365Py_Finalize(void)
1366{
1367 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001368}
1369
1370/* Create and initialize a new interpreter and thread, and return the
1371 new thread. This requires that Py_Initialize() has been called
1372 first.
1373
1374 Unsuccessful initialization yields a NULL pointer. Note that *no*
1375 exception information is available even in this case -- the
1376 exception information is held in the thread, and there is no
1377 thread.
1378
1379 Locking: as above.
1380
1381*/
1382
Victor Stinner331a6a52019-05-27 16:39:22 +02001383static PyStatus
Victor Stinnera7368ac2017-11-15 18:11:45 -08001384new_interpreter(PyThreadState **tstate_p)
Nick Coghland6009512014-11-20 21:39:37 +10001385{
Victor Stinner331a6a52019-05-27 16:39:22 +02001386 PyStatus status;
Nick Coghland6009512014-11-20 21:39:37 +10001387
Victor Stinner331a6a52019-05-27 16:39:22 +02001388 status = _PyRuntime_Initialize();
1389 if (_PyStatus_EXCEPTION(status)) {
1390 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001391 }
1392 _PyRuntimeState *runtime = &_PyRuntime;
1393
1394 if (!runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001395 return _PyStatus_ERR("Py_Initialize must be called first");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001396 }
Nick Coghland6009512014-11-20 21:39:37 +10001397
Victor Stinner8a1be612016-03-14 22:07:55 +01001398 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1399 interpreters: disable PyGILState_Check(). */
1400 _PyGILState_check_enabled = 0;
1401
Victor Stinner43125222019-04-24 18:23:53 +02001402 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001403 if (interp == NULL) {
1404 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001405 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001406 }
Nick Coghland6009512014-11-20 21:39:37 +10001407
Victor Stinner43125222019-04-24 18:23:53 +02001408 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001409 if (tstate == NULL) {
1410 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001411 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001412 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001413 }
1414
Victor Stinner43125222019-04-24 18:23:53 +02001415 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001416
Eric Snow1abcf672017-05-23 21:46:51 -07001417 /* Copy the current interpreter config into the new interpreter */
Victor Stinner331a6a52019-05-27 16:39:22 +02001418 PyConfig *config;
Eric Snow1abcf672017-05-23 21:46:51 -07001419 if (save_tstate != NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001420 config = &save_tstate->interp->config;
Eric Snow1abcf672017-05-23 21:46:51 -07001421 } else {
1422 /* No current thread state, copy from the main interpreter */
1423 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinner331a6a52019-05-27 16:39:22 +02001424 config = &main_interp->config;
Victor Stinnerda273412017-12-15 01:46:02 +01001425 }
1426
Victor Stinner331a6a52019-05-27 16:39:22 +02001427 status = _PyConfig_Copy(&interp->config, config);
1428 if (_PyStatus_EXCEPTION(status)) {
1429 return status;
Victor Stinnerda273412017-12-15 01:46:02 +01001430 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001431 config = &interp->config;
Eric Snow1abcf672017-05-23 21:46:51 -07001432
Victor Stinner331a6a52019-05-27 16:39:22 +02001433 status = _PyExc_Init();
1434 if (_PyStatus_EXCEPTION(status)) {
1435 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001436 }
1437
Victor Stinner331a6a52019-05-27 16:39:22 +02001438 status = _PyErr_Init();
1439 if (_PyStatus_EXCEPTION(status)) {
1440 return status;
Victor Stinneref9d9b62019-05-22 11:28:22 +02001441 }
1442
1443
Nick Coghland6009512014-11-20 21:39:37 +10001444 /* XXX The following is lax in error checking */
Eric Snowd393c1b2017-09-14 12:18:12 -06001445 PyObject *modules = PyDict_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001446 if (modules == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001447 return _PyStatus_ERR("can't make modules dictionary");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001448 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001449 interp->modules = modules;
Nick Coghland6009512014-11-20 21:39:37 +10001450
Victor Stinner43125222019-04-24 18:23:53 +02001451 PyObject *sysmod = _PyImport_FindBuiltin("sys", modules);
Eric Snowd393c1b2017-09-14 12:18:12 -06001452 if (sysmod != NULL) {
1453 interp->sysdict = PyModule_GetDict(sysmod);
Victor Stinner43125222019-04-24 18:23:53 +02001454 if (interp->sysdict == NULL) {
Eric Snowd393c1b2017-09-14 12:18:12 -06001455 goto handle_error;
Victor Stinner43125222019-04-24 18:23:53 +02001456 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001457 Py_INCREF(interp->sysdict);
1458 PyDict_SetItemString(interp->sysdict, "modules", modules);
Victor Stinner0fd2c302019-06-04 03:15:09 +02001459 if (_PySys_InitMain(runtime, interp) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001460 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerab672812019-01-23 15:04:40 +01001461 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001462 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001463 else if (PyErr_Occurred()) {
1464 goto handle_error;
1465 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001466
Victor Stinner43125222019-04-24 18:23:53 +02001467 PyObject *bimod = _PyImport_FindBuiltin("builtins", modules);
Nick Coghland6009512014-11-20 21:39:37 +10001468 if (bimod != NULL) {
1469 interp->builtins = PyModule_GetDict(bimod);
1470 if (interp->builtins == NULL)
1471 goto handle_error;
1472 Py_INCREF(interp->builtins);
1473 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001474 else if (PyErr_Occurred()) {
1475 goto handle_error;
1476 }
Nick Coghland6009512014-11-20 21:39:37 +10001477
Nick Coghland6009512014-11-20 21:39:37 +10001478 if (bimod != NULL && sysmod != NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001479 status = _PyBuiltins_AddExceptions(bimod);
1480 if (_PyStatus_EXCEPTION(status)) {
1481 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001482 }
Nick Coghland6009512014-11-20 21:39:37 +10001483
Victor Stinner331a6a52019-05-27 16:39:22 +02001484 status = _PySys_SetPreliminaryStderr(interp->sysdict);
1485 if (_PyStatus_EXCEPTION(status)) {
1486 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001487 }
Nick Coghland6009512014-11-20 21:39:37 +10001488
Victor Stinner331a6a52019-05-27 16:39:22 +02001489 status = _PyImportHooks_Init();
1490 if (_PyStatus_EXCEPTION(status)) {
1491 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001492 }
Nick Coghland6009512014-11-20 21:39:37 +10001493
Victor Stinner331a6a52019-05-27 16:39:22 +02001494 status = init_importlib(interp, sysmod);
1495 if (_PyStatus_EXCEPTION(status)) {
1496 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001497 }
Nick Coghland6009512014-11-20 21:39:37 +10001498
Victor Stinner331a6a52019-05-27 16:39:22 +02001499 status = init_importlib_external(interp);
1500 if (_PyStatus_EXCEPTION(status)) {
1501 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001502 }
Nick Coghland6009512014-11-20 21:39:37 +10001503
Victor Stinner331a6a52019-05-27 16:39:22 +02001504 status = _PyUnicode_InitEncodings(interp);
1505 if (_PyStatus_EXCEPTION(status)) {
1506 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001507 }
1508
Victor Stinner331a6a52019-05-27 16:39:22 +02001509 status = init_sys_streams(interp);
1510 if (_PyStatus_EXCEPTION(status)) {
1511 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001512 }
1513
Victor Stinner331a6a52019-05-27 16:39:22 +02001514 status = add_main_module(interp);
1515 if (_PyStatus_EXCEPTION(status)) {
1516 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001517 }
1518
Victor Stinner331a6a52019-05-27 16:39:22 +02001519 if (config->site_import) {
1520 status = init_import_size();
1521 if (_PyStatus_EXCEPTION(status)) {
1522 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001523 }
1524 }
Nick Coghland6009512014-11-20 21:39:37 +10001525 }
1526
Victor Stinnera7368ac2017-11-15 18:11:45 -08001527 if (PyErr_Occurred()) {
1528 goto handle_error;
1529 }
Nick Coghland6009512014-11-20 21:39:37 +10001530
Victor Stinnera7368ac2017-11-15 18:11:45 -08001531 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +02001532 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001533
Nick Coghland6009512014-11-20 21:39:37 +10001534handle_error:
1535 /* Oops, it didn't work. Undo it all. */
1536
1537 PyErr_PrintEx(0);
1538 PyThreadState_Clear(tstate);
1539 PyThreadState_Swap(save_tstate);
1540 PyThreadState_Delete(tstate);
1541 PyInterpreterState_Delete(interp);
1542
Victor Stinnera7368ac2017-11-15 18:11:45 -08001543 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001544 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001545}
1546
1547PyThreadState *
1548Py_NewInterpreter(void)
1549{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001550 PyThreadState *tstate = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001551 PyStatus status = new_interpreter(&tstate);
1552 if (_PyStatus_EXCEPTION(status)) {
1553 Py_ExitStatusException(status);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001554 }
1555 return tstate;
1556
Nick Coghland6009512014-11-20 21:39:37 +10001557}
1558
1559/* Delete an interpreter and its last thread. This requires that the
1560 given thread state is current, that the thread has no remaining
1561 frames, and that it is its interpreter's only remaining thread.
1562 It is a fatal error to violate these constraints.
1563
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001564 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001565 everything, regardless.)
1566
1567 Locking: as above.
1568
1569*/
1570
1571void
1572Py_EndInterpreter(PyThreadState *tstate)
1573{
1574 PyInterpreterState *interp = tstate->interp;
1575
Victor Stinner50b48572018-11-01 01:51:40 +01001576 if (tstate != _PyThreadState_GET())
Nick Coghland6009512014-11-20 21:39:37 +10001577 Py_FatalError("Py_EndInterpreter: thread is not current");
1578 if (tstate->frame != NULL)
1579 Py_FatalError("Py_EndInterpreter: thread still has a frame");
Eric Snow5be45a62019-03-08 22:47:07 -07001580 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001581
Eric Snow842a2f02019-03-15 15:47:51 -06001582 // Wrap up existing "threading"-module-created, non-daemon threads.
Nick Coghland6009512014-11-20 21:39:37 +10001583 wait_for_thread_shutdown();
1584
Marcel Plch776407f2017-12-20 11:17:58 +01001585 call_py_exitfuncs(interp);
1586
Nick Coghland6009512014-11-20 21:39:37 +10001587 if (tstate != interp->tstate_head || tstate->next != NULL)
1588 Py_FatalError("Py_EndInterpreter: not the last thread");
1589
1590 PyImport_Cleanup();
1591 PyInterpreterState_Clear(interp);
1592 PyThreadState_Swap(NULL);
1593 PyInterpreterState_Delete(interp);
1594}
1595
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001596/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001597
Victor Stinner331a6a52019-05-27 16:39:22 +02001598static PyStatus
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001599add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001600{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001601 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001602 m = PyImport_AddModule("__main__");
1603 if (m == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +02001604 return _PyStatus_ERR("can't create __main__ module");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001605
Nick Coghland6009512014-11-20 21:39:37 +10001606 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001607 ann_dict = PyDict_New();
1608 if ((ann_dict == NULL) ||
1609 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001610 return _PyStatus_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001611 }
1612 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001613
Nick Coghland6009512014-11-20 21:39:37 +10001614 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1615 PyObject *bimod = PyImport_ImportModule("builtins");
1616 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001617 return _PyStatus_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001618 }
1619 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001620 return _PyStatus_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001621 }
1622 Py_DECREF(bimod);
1623 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001624
Nick Coghland6009512014-11-20 21:39:37 +10001625 /* Main is a little special - imp.is_builtin("__main__") will return
1626 * False, but BuiltinImporter is still the most appropriate initial
1627 * setting for its __loader__ attribute. A more suitable value will
1628 * be set if __main__ gets further initialized later in the startup
1629 * process.
1630 */
1631 loader = PyDict_GetItemString(d, "__loader__");
1632 if (loader == NULL || loader == Py_None) {
1633 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1634 "BuiltinImporter");
1635 if (loader == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001636 return _PyStatus_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001637 }
1638 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001639 return _PyStatus_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001640 }
1641 Py_DECREF(loader);
1642 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001643 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001644}
1645
Nick Coghland6009512014-11-20 21:39:37 +10001646/* Import the site module (not into __main__ though) */
1647
Victor Stinner331a6a52019-05-27 16:39:22 +02001648static PyStatus
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001649init_import_size(void)
Nick Coghland6009512014-11-20 21:39:37 +10001650{
1651 PyObject *m;
1652 m = PyImport_ImportModule("site");
1653 if (m == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001654 return _PyStatus_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001655 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001656 Py_DECREF(m);
Victor Stinner331a6a52019-05-27 16:39:22 +02001657 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001658}
1659
Victor Stinner874dbe82015-09-04 17:29:57 +02001660/* Check if a file descriptor is valid or not.
1661 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1662static int
1663is_valid_fd(int fd)
1664{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001665/* dup() is faster than fstat(): fstat() can require input/output operations,
1666 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1667 startup. Problem: dup() doesn't check if the file descriptor is valid on
1668 some platforms.
1669
1670 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1671 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1672 EBADF. FreeBSD has similar issue (bpo-32849).
1673
1674 Only use dup() on platforms where dup() is enough to detect invalid FD in
1675 corner cases: on Linux and Windows (bpo-32849). */
1676#if defined(__linux__) || defined(MS_WINDOWS)
1677 if (fd < 0) {
1678 return 0;
1679 }
1680 int fd2;
1681
1682 _Py_BEGIN_SUPPRESS_IPH
1683 fd2 = dup(fd);
1684 if (fd2 >= 0) {
1685 close(fd2);
1686 }
1687 _Py_END_SUPPRESS_IPH
1688
1689 return (fd2 >= 0);
1690#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001691 struct stat st;
1692 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001693#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001694}
1695
1696/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001697static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02001698create_stdio(const PyConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001699 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001700 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001701{
1702 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1703 const char* mode;
1704 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001705 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001706 int buffering, isatty;
1707 _Py_IDENTIFIER(open);
1708 _Py_IDENTIFIER(isatty);
1709 _Py_IDENTIFIER(TextIOWrapper);
1710 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001711 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001712
Victor Stinner874dbe82015-09-04 17:29:57 +02001713 if (!is_valid_fd(fd))
1714 Py_RETURN_NONE;
1715
Nick Coghland6009512014-11-20 21:39:37 +10001716 /* stdin is always opened in buffered mode, first because it shouldn't
1717 make a difference in common use cases, second because TextIOWrapper
1718 depends on the presence of a read1() method which only exists on
1719 buffered streams.
1720 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001721 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001722 buffering = 0;
1723 else
1724 buffering = -1;
1725 if (write_mode)
1726 mode = "wb";
1727 else
1728 mode = "rb";
1729 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOi",
1730 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001731 Py_None, Py_None, /* encoding, errors */
1732 Py_None, 0); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001733 if (buf == NULL)
1734 goto error;
1735
1736 if (buffering) {
1737 _Py_IDENTIFIER(raw);
1738 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1739 if (raw == NULL)
1740 goto error;
1741 }
1742 else {
1743 raw = buf;
1744 Py_INCREF(raw);
1745 }
1746
Steve Dower39294992016-08-30 21:22:36 -07001747#ifdef MS_WINDOWS
1748 /* Windows console IO is always UTF-8 encoded */
1749 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001750 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001751#endif
1752
Nick Coghland6009512014-11-20 21:39:37 +10001753 text = PyUnicode_FromString(name);
1754 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1755 goto error;
Victor Stinner3466bde2016-09-05 18:16:01 -07001756 res = _PyObject_CallMethodId(raw, &PyId_isatty, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10001757 if (res == NULL)
1758 goto error;
1759 isatty = PyObject_IsTrue(res);
1760 Py_DECREF(res);
1761 if (isatty == -1)
1762 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001763 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001764 write_through = Py_True;
1765 else
1766 write_through = Py_False;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001767 if (isatty && buffered_stdio)
Nick Coghland6009512014-11-20 21:39:37 +10001768 line_buffering = Py_True;
1769 else
1770 line_buffering = Py_False;
1771
1772 Py_CLEAR(raw);
1773 Py_CLEAR(text);
1774
1775#ifdef MS_WINDOWS
1776 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1777 newlines to "\n".
1778 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1779 newline = NULL;
1780#else
1781 /* sys.stdin: split lines at "\n".
1782 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1783 newline = "\n";
1784#endif
1785
Victor Stinner709d23d2019-05-02 14:56:30 -04001786 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1787 if (encoding_str == NULL) {
1788 Py_CLEAR(buf);
1789 goto error;
1790 }
1791
1792 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1793 if (errors_str == NULL) {
1794 Py_CLEAR(buf);
1795 Py_CLEAR(encoding_str);
1796 goto error;
1797 }
1798
1799 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1800 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001801 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001802 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001803 Py_CLEAR(encoding_str);
1804 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001805 if (stream == NULL)
1806 goto error;
1807
1808 if (write_mode)
1809 mode = "w";
1810 else
1811 mode = "r";
1812 text = PyUnicode_FromString(mode);
1813 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1814 goto error;
1815 Py_CLEAR(text);
1816 return stream;
1817
1818error:
1819 Py_XDECREF(buf);
1820 Py_XDECREF(stream);
1821 Py_XDECREF(text);
1822 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001823
Victor Stinner874dbe82015-09-04 17:29:57 +02001824 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1825 /* Issue #24891: the file descriptor was closed after the first
1826 is_valid_fd() check was called. Ignore the OSError and set the
1827 stream to None. */
1828 PyErr_Clear();
1829 Py_RETURN_NONE;
1830 }
1831 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001832}
1833
1834/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinner331a6a52019-05-27 16:39:22 +02001835static PyStatus
Victor Stinner91106cd2017-12-13 12:29:09 +01001836init_sys_streams(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001837{
1838 PyObject *iomod = NULL, *wrapper;
1839 PyObject *bimod = NULL;
1840 PyObject *m;
1841 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001842 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001843 PyObject * encoding_attr;
Victor Stinner331a6a52019-05-27 16:39:22 +02001844 PyStatus res = _PyStatus_OK();
1845 PyConfig *config = &interp->config;
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001846
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001847 /* Check that stdin is not a directory
1848 Using shell redirection, you can redirect stdin to a directory,
1849 crashing the Python interpreter. Catch this common mistake here
1850 and output a useful error message. Note that under MS Windows,
1851 the shell already prevents that. */
1852#ifndef MS_WINDOWS
1853 struct _Py_stat_struct sb;
1854 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1855 S_ISDIR(sb.st_mode)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001856 return _PyStatus_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001857 }
1858#endif
1859
Nick Coghland6009512014-11-20 21:39:37 +10001860 /* Hack to avoid a nasty recursion issue when Python is invoked
1861 in verbose mode: pre-import the Latin-1 and UTF-8 codecs */
1862 if ((m = PyImport_ImportModule("encodings.utf_8")) == NULL) {
1863 goto error;
1864 }
1865 Py_DECREF(m);
1866
1867 if (!(m = PyImport_ImportModule("encodings.latin_1"))) {
1868 goto error;
1869 }
1870 Py_DECREF(m);
1871
1872 if (!(bimod = PyImport_ImportModule("builtins"))) {
1873 goto error;
1874 }
1875
1876 if (!(iomod = PyImport_ImportModule("io"))) {
1877 goto error;
1878 }
1879 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1880 goto error;
1881 }
1882
1883 /* Set builtins.open */
1884 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1885 Py_DECREF(wrapper);
1886 goto error;
1887 }
1888 Py_DECREF(wrapper);
1889
Nick Coghland6009512014-11-20 21:39:37 +10001890 /* Set sys.stdin */
1891 fd = fileno(stdin);
1892 /* Under some conditions stdin, stdout and stderr may not be connected
1893 * and fileno() may point to an invalid file descriptor. For example
1894 * GUI apps don't have valid standard streams by default.
1895 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001896 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001897 config->stdio_encoding,
1898 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001899 if (std == NULL)
1900 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001901 PySys_SetObject("__stdin__", std);
1902 _PySys_SetObjectId(&PyId_stdin, std);
1903 Py_DECREF(std);
1904
1905 /* Set sys.stdout */
1906 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001907 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001908 config->stdio_encoding,
1909 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001910 if (std == NULL)
1911 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001912 PySys_SetObject("__stdout__", std);
1913 _PySys_SetObjectId(&PyId_stdout, std);
1914 Py_DECREF(std);
1915
1916#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
1917 /* Set sys.stderr, replaces the preliminary stderr */
1918 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001919 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001920 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04001921 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02001922 if (std == NULL)
1923 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001924
1925 /* Same as hack above, pre-import stderr's codec to avoid recursion
1926 when import.c tries to write to stderr in verbose mode. */
1927 encoding_attr = PyObject_GetAttrString(std, "encoding");
1928 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001929 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10001930 if (std_encoding != NULL) {
1931 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
1932 Py_XDECREF(codec_info);
1933 }
1934 Py_DECREF(encoding_attr);
1935 }
1936 PyErr_Clear(); /* Not a fatal error if codec isn't available */
1937
1938 if (PySys_SetObject("__stderr__", std) < 0) {
1939 Py_DECREF(std);
1940 goto error;
1941 }
1942 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
1943 Py_DECREF(std);
1944 goto error;
1945 }
1946 Py_DECREF(std);
1947#endif
1948
Victor Stinnera7368ac2017-11-15 18:11:45 -08001949 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10001950
Victor Stinnera7368ac2017-11-15 18:11:45 -08001951error:
Victor Stinner331a6a52019-05-27 16:39:22 +02001952 res = _PyStatus_ERR("can't initialize sys standard streams");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001953
1954done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02001955 _Py_ClearStandardStreamEncoding();
Victor Stinner31e99082017-12-20 23:41:38 +01001956
Nick Coghland6009512014-11-20 21:39:37 +10001957 Py_XDECREF(bimod);
1958 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001959 return res;
Nick Coghland6009512014-11-20 21:39:37 +10001960}
1961
1962
Victor Stinner10dc4842015-03-24 12:01:30 +01001963static void
Victor Stinner791da1c2016-03-14 16:53:12 +01001964_Py_FatalError_DumpTracebacks(int fd)
Victor Stinner10dc4842015-03-24 12:01:30 +01001965{
Victor Stinner10dc4842015-03-24 12:01:30 +01001966 fputc('\n', stderr);
1967 fflush(stderr);
1968
1969 /* display the current Python stack */
Victor Stinner861d9ab2016-03-16 22:45:24 +01001970 _Py_DumpTracebackThreads(fd, NULL, NULL);
Victor Stinner10dc4842015-03-24 12:01:30 +01001971}
Victor Stinner791da1c2016-03-14 16:53:12 +01001972
1973/* Print the current exception (if an exception is set) with its traceback,
1974 or display the current Python stack.
1975
1976 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
1977 called on catastrophic cases.
1978
1979 Return 1 if the traceback was displayed, 0 otherwise. */
1980
1981static int
1982_Py_FatalError_PrintExc(int fd)
1983{
1984 PyObject *ferr, *res;
1985 PyObject *exception, *v, *tb;
1986 int has_tb;
1987
Victor Stinner791da1c2016-03-14 16:53:12 +01001988 PyErr_Fetch(&exception, &v, &tb);
1989 if (exception == NULL) {
1990 /* No current exception */
1991 return 0;
1992 }
1993
1994 ferr = _PySys_GetObjectId(&PyId_stderr);
1995 if (ferr == NULL || ferr == Py_None) {
1996 /* sys.stderr is not set yet or set to None,
1997 no need to try to display the exception */
1998 return 0;
1999 }
2000
2001 PyErr_NormalizeException(&exception, &v, &tb);
2002 if (tb == NULL) {
2003 tb = Py_None;
2004 Py_INCREF(tb);
2005 }
2006 PyException_SetTraceback(v, tb);
2007 if (exception == NULL) {
2008 /* PyErr_NormalizeException() failed */
2009 return 0;
2010 }
2011
2012 has_tb = (tb != Py_None);
2013 PyErr_Display(exception, v, tb);
2014 Py_XDECREF(exception);
2015 Py_XDECREF(v);
2016 Py_XDECREF(tb);
2017
2018 /* sys.stderr may be buffered: call sys.stderr.flush() */
Victor Stinner3466bde2016-09-05 18:16:01 -07002019 res = _PyObject_CallMethodId(ferr, &PyId_flush, NULL);
Victor Stinner791da1c2016-03-14 16:53:12 +01002020 if (res == NULL)
2021 PyErr_Clear();
2022 else
2023 Py_DECREF(res);
2024
2025 return has_tb;
2026}
2027
Nick Coghland6009512014-11-20 21:39:37 +10002028/* Print fatal error message and abort */
2029
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002030#ifdef MS_WINDOWS
2031static void
2032fatal_output_debug(const char *msg)
2033{
2034 /* buffer of 256 bytes allocated on the stack */
2035 WCHAR buffer[256 / sizeof(WCHAR)];
2036 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2037 size_t msglen;
2038
2039 OutputDebugStringW(L"Fatal Python error: ");
2040
2041 msglen = strlen(msg);
2042 while (msglen) {
2043 size_t i;
2044
2045 if (buflen > msglen) {
2046 buflen = msglen;
2047 }
2048
2049 /* Convert the message to wchar_t. This uses a simple one-to-one
2050 conversion, assuming that the this error message actually uses
2051 ASCII only. If this ceases to be true, we will have to convert. */
2052 for (i=0; i < buflen; ++i) {
2053 buffer[i] = msg[i];
2054 }
2055 buffer[i] = L'\0';
2056 OutputDebugStringW(buffer);
2057
2058 msg += buflen;
2059 msglen -= buflen;
2060 }
2061 OutputDebugStringW(L"\n");
2062}
2063#endif
2064
Benjamin Petersoncef88b92017-11-25 13:02:55 -08002065static void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002066fatal_error(const char *prefix, const char *msg, int status)
Nick Coghland6009512014-11-20 21:39:37 +10002067{
2068 const int fd = fileno(stderr);
Victor Stinner53345a42015-03-25 01:55:14 +01002069 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002070
2071 if (reentrant) {
2072 /* Py_FatalError() caused a second fatal error.
2073 Example: flush_std_files() raises a recursion error. */
2074 goto exit;
2075 }
2076 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002077
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002078 fprintf(stderr, "Fatal Python error: ");
2079 if (prefix) {
2080 fputs(prefix, stderr);
2081 fputs(": ", stderr);
2082 }
2083 if (msg) {
2084 fputs(msg, stderr);
2085 }
2086 else {
2087 fprintf(stderr, "<message not set>");
2088 }
2089 fputs("\n", stderr);
Nick Coghland6009512014-11-20 21:39:37 +10002090 fflush(stderr); /* it helps in Windows debug build */
Victor Stinner10dc4842015-03-24 12:01:30 +01002091
Victor Stinner3a228ab2018-11-01 00:26:41 +01002092 /* Check if the current thread has a Python thread state
2093 and holds the GIL */
2094 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2095 if (tss_tstate != NULL) {
Victor Stinner50b48572018-11-01 01:51:40 +01002096 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner3a228ab2018-11-01 00:26:41 +01002097 if (tss_tstate != tstate) {
2098 /* The Python thread does not hold the GIL */
2099 tss_tstate = NULL;
2100 }
2101 }
2102 else {
2103 /* Py_FatalError() has been called from a C thread
2104 which has no Python thread state. */
2105 }
2106 int has_tstate_and_gil = (tss_tstate != NULL);
2107
2108 if (has_tstate_and_gil) {
2109 /* If an exception is set, print the exception with its traceback */
2110 if (!_Py_FatalError_PrintExc(fd)) {
2111 /* No exception is set, or an exception is set without traceback */
2112 _Py_FatalError_DumpTracebacks(fd);
2113 }
2114 }
2115 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002116 _Py_FatalError_DumpTracebacks(fd);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002117 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002118
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002119 /* The main purpose of faulthandler is to display the traceback.
2120 This function already did its best to display a traceback.
2121 Disable faulthandler to prevent writing a second traceback
2122 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002123 _PyFaulthandler_Fini();
2124
Victor Stinner791da1c2016-03-14 16:53:12 +01002125 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002126 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002127 /* Flush sys.stdout and sys.stderr */
2128 flush_std_files();
2129 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002130
Nick Coghland6009512014-11-20 21:39:37 +10002131#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002132 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002133#endif /* MS_WINDOWS */
2134
2135exit:
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002136 if (status < 0) {
Victor Stinner53345a42015-03-25 01:55:14 +01002137#if defined(MS_WINDOWS) && defined(_DEBUG)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002138 DebugBreak();
Nick Coghland6009512014-11-20 21:39:37 +10002139#endif
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002140 abort();
2141 }
2142 else {
2143 exit(status);
2144 }
2145}
2146
Victor Stinner19760862017-12-20 01:41:59 +01002147void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002148Py_FatalError(const char *msg)
2149{
2150 fatal_error(NULL, msg, -1);
2151}
2152
Victor Stinner19760862017-12-20 01:41:59 +01002153void _Py_NO_RETURN
Victor Stinner331a6a52019-05-27 16:39:22 +02002154Py_ExitStatusException(PyStatus status)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002155{
Victor Stinner331a6a52019-05-27 16:39:22 +02002156 if (_PyStatus_IS_EXIT(status)) {
2157 exit(status.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002158 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002159 else if (_PyStatus_IS_ERROR(status)) {
2160 fatal_error(status.func, status.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002161 }
2162 else {
Victor Stinner331a6a52019-05-27 16:39:22 +02002163 Py_FatalError("Py_ExitStatusException() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002164 }
Nick Coghland6009512014-11-20 21:39:37 +10002165}
2166
2167/* Clean up and exit */
2168
Victor Stinnerd7292b52016-06-17 12:29:00 +02002169# include "pythread.h"
Nick Coghland6009512014-11-20 21:39:37 +10002170
Nick Coghland6009512014-11-20 21:39:37 +10002171/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002172void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002173{
Victor Stinnercaba55b2018-08-03 15:33:52 +02002174 PyInterpreterState *is = _PyInterpreterState_Get();
Marcel Plch776407f2017-12-20 11:17:58 +01002175
Antoine Pitroufc5db952017-12-13 02:29:07 +01002176 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002177 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2178
2179 is->pyexitfunc = func;
2180 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002181}
2182
2183static void
Marcel Plch776407f2017-12-20 11:17:58 +01002184call_py_exitfuncs(PyInterpreterState *istate)
Nick Coghland6009512014-11-20 21:39:37 +10002185{
Marcel Plch776407f2017-12-20 11:17:58 +01002186 if (istate->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002187 return;
2188
Marcel Plch776407f2017-12-20 11:17:58 +01002189 (*istate->pyexitfunc)(istate->pyexitmodule);
Nick Coghland6009512014-11-20 21:39:37 +10002190 PyErr_Clear();
2191}
2192
2193/* Wait until threading._shutdown completes, provided
2194 the threading module was imported in the first place.
2195 The shutdown routine will wait until all non-daemon
2196 "threading" threads have completed. */
2197static void
2198wait_for_thread_shutdown(void)
2199{
Nick Coghland6009512014-11-20 21:39:37 +10002200 _Py_IDENTIFIER(_shutdown);
2201 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002202 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002203 if (threading == NULL) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002204 if (PyErr_Occurred()) {
2205 PyErr_WriteUnraisable(NULL);
2206 }
2207 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002208 return;
2209 }
Victor Stinner3466bde2016-09-05 18:16:01 -07002210 result = _PyObject_CallMethodId(threading, &PyId__shutdown, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10002211 if (result == NULL) {
2212 PyErr_WriteUnraisable(threading);
2213 }
2214 else {
2215 Py_DECREF(result);
2216 }
2217 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002218}
2219
2220#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002221int Py_AtExit(void (*func)(void))
2222{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002223 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002224 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002225 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002226 return 0;
2227}
2228
2229static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002230call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002231{
Victor Stinner8e91c242019-04-24 17:24:01 +02002232 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002233 /* pop last function from the list */
2234 runtime->nexitfuncs--;
2235 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2236 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2237
2238 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002239 }
Nick Coghland6009512014-11-20 21:39:37 +10002240
2241 fflush(stdout);
2242 fflush(stderr);
2243}
2244
Victor Stinnercfc88312018-08-01 16:41:25 +02002245void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002246Py_Exit(int sts)
2247{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002248 if (Py_FinalizeEx() < 0) {
2249 sts = 120;
2250 }
Nick Coghland6009512014-11-20 21:39:37 +10002251
2252 exit(sts);
2253}
2254
Victor Stinner331a6a52019-05-27 16:39:22 +02002255static PyStatus
Victor Stinner43fc3bb2019-05-02 11:54:20 -04002256init_signals(void)
Nick Coghland6009512014-11-20 21:39:37 +10002257{
2258#ifdef SIGPIPE
2259 PyOS_setsig(SIGPIPE, SIG_IGN);
2260#endif
2261#ifdef SIGXFZ
2262 PyOS_setsig(SIGXFZ, SIG_IGN);
2263#endif
2264#ifdef SIGXFSZ
2265 PyOS_setsig(SIGXFSZ, SIG_IGN);
2266#endif
2267 PyOS_InitInterrupts(); /* May imply initsignal() */
2268 if (PyErr_Occurred()) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002269 return _PyStatus_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002270 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002271 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002272}
2273
2274
2275/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2276 *
2277 * All of the code in this function must only use async-signal-safe functions,
2278 * listed at `man 7 signal` or
2279 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2280 */
2281void
2282_Py_RestoreSignals(void)
2283{
2284#ifdef SIGPIPE
2285 PyOS_setsig(SIGPIPE, SIG_DFL);
2286#endif
2287#ifdef SIGXFZ
2288 PyOS_setsig(SIGXFZ, SIG_DFL);
2289#endif
2290#ifdef SIGXFSZ
2291 PyOS_setsig(SIGXFSZ, SIG_DFL);
2292#endif
2293}
2294
2295
2296/*
2297 * The file descriptor fd is considered ``interactive'' if either
2298 * a) isatty(fd) is TRUE, or
2299 * b) the -i flag was given, and the filename associated with
2300 * the descriptor is NULL or "<stdin>" or "???".
2301 */
2302int
2303Py_FdIsInteractive(FILE *fp, const char *filename)
2304{
2305 if (isatty((int)fileno(fp)))
2306 return 1;
2307 if (!Py_InteractiveFlag)
2308 return 0;
2309 return (filename == NULL) ||
2310 (strcmp(filename, "<stdin>") == 0) ||
2311 (strcmp(filename, "???") == 0);
2312}
2313
2314
Nick Coghland6009512014-11-20 21:39:37 +10002315/* Wrappers around sigaction() or signal(). */
2316
2317PyOS_sighandler_t
2318PyOS_getsig(int sig)
2319{
2320#ifdef HAVE_SIGACTION
2321 struct sigaction context;
2322 if (sigaction(sig, NULL, &context) == -1)
2323 return SIG_ERR;
2324 return context.sa_handler;
2325#else
2326 PyOS_sighandler_t handler;
2327/* Special signal handling for the secure CRT in Visual Studio 2005 */
2328#if defined(_MSC_VER) && _MSC_VER >= 1400
2329 switch (sig) {
2330 /* Only these signals are valid */
2331 case SIGINT:
2332 case SIGILL:
2333 case SIGFPE:
2334 case SIGSEGV:
2335 case SIGTERM:
2336 case SIGBREAK:
2337 case SIGABRT:
2338 break;
2339 /* Don't call signal() with other values or it will assert */
2340 default:
2341 return SIG_ERR;
2342 }
2343#endif /* _MSC_VER && _MSC_VER >= 1400 */
2344 handler = signal(sig, SIG_IGN);
2345 if (handler != SIG_ERR)
2346 signal(sig, handler);
2347 return handler;
2348#endif
2349}
2350
2351/*
2352 * All of the code in this function must only use async-signal-safe functions,
2353 * listed at `man 7 signal` or
2354 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2355 */
2356PyOS_sighandler_t
2357PyOS_setsig(int sig, PyOS_sighandler_t handler)
2358{
2359#ifdef HAVE_SIGACTION
2360 /* Some code in Modules/signalmodule.c depends on sigaction() being
2361 * used here if HAVE_SIGACTION is defined. Fix that if this code
2362 * changes to invalidate that assumption.
2363 */
2364 struct sigaction context, ocontext;
2365 context.sa_handler = handler;
2366 sigemptyset(&context.sa_mask);
2367 context.sa_flags = 0;
2368 if (sigaction(sig, &context, &ocontext) == -1)
2369 return SIG_ERR;
2370 return ocontext.sa_handler;
2371#else
2372 PyOS_sighandler_t oldhandler;
2373 oldhandler = signal(sig, handler);
2374#ifdef HAVE_SIGINTERRUPT
2375 siginterrupt(sig, 1);
2376#endif
2377 return oldhandler;
2378#endif
2379}
2380
2381#ifdef __cplusplus
2382}
2383#endif