blob: 10a28813faa8dbe93abd7a894d39b891788bbb1d [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 Stinner43125222019-04-24 18:23:53 +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 Stinner331a6a52019-05-27 16:39:22 +0200686 status = _PySys_Create(runtime, interp, &sysmod);
687 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 Stinner5edcf262019-05-23 00:57:57 +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 Stinner43125222019-04-24 18:23:53 +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 Stinner5edcf262019-05-23 00:57:57 +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 Stinner331a6a52019-05-27 16:39:22 +02001029 status = pyinit_main(runtime, interp);
1030 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 Stinner09532fe2019-05-10 23:39:09 +02001153 _Py_FinishPendingCalls(runtime);
Eric Snow842a2f02019-03-15 15:47:51 -06001154
Victor Stinner8e91c242019-04-24 17:24:01 +02001155 /* Get current thread state and interpreter pointer */
Victor Stinner09532fe2019-05-10 23:39:09 +02001156 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
Victor Stinner8e91c242019-04-24 17:24:01 +02001157 PyInterpreterState *interp = tstate->interp;
1158
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
Victor Stinnere0deff32015-03-24 13:46:18 +01001228 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001229 if (flush_std_files() < 0) {
1230 status = -1;
1231 }
Nick Coghland6009512014-11-20 21:39:37 +10001232
1233 /* Collect final garbage. This disposes of cycles created by
1234 * class definitions, for example.
1235 * XXX This is disabled because it caused too many problems. If
1236 * XXX a __del__ or weakref callback triggers here, Python code has
1237 * XXX a hard time running, because even the sys module has been
1238 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1239 * XXX One symptom is a sequence of information-free messages
1240 * XXX coming from threads (if a __del__ or callback is invoked,
1241 * XXX other threads can execute too, and any exception they encounter
1242 * XXX triggers a comedy of errors as subsystem after subsystem
1243 * XXX fails to find what it *expects* to find in sys to help report
1244 * XXX the exception and consequent unexpected failures). I've also
1245 * XXX seen segfaults then, after adding print statements to the
1246 * XXX Python code getting called.
1247 */
1248#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001249 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001250#endif
1251
1252 /* Disable tracemalloc after all Python objects have been destroyed,
1253 so it is possible to use tracemalloc in objects destructor. */
1254 _PyTraceMalloc_Fini();
1255
1256 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1257 _PyImport_Fini();
1258
1259 /* Cleanup typeobject.c's internal caches. */
1260 _PyType_Fini();
1261
1262 /* unload faulthandler module */
1263 _PyFaulthandler_Fini();
1264
1265 /* Debugging stuff */
1266#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001267 _Py_dump_counts(stderr);
Nick Coghland6009512014-11-20 21:39:37 +10001268#endif
1269 /* dump hash stats */
1270 _PyHash_Fini();
1271
Eric Snowdae02762017-09-14 00:35:58 -07001272#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001273 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001274 _PyDebug_PrintTotalRefs();
1275 }
Eric Snowdae02762017-09-14 00:35:58 -07001276#endif
Nick Coghland6009512014-11-20 21:39:37 +10001277
1278#ifdef Py_TRACE_REFS
1279 /* Display all objects still alive -- this can invoke arbitrary
1280 * __repr__ overrides, so requires a mostly-intact interpreter.
1281 * Alas, a lot of stuff may still be alive now that will be cleaned
1282 * up later.
1283 */
Victor Stinnerda273412017-12-15 01:46:02 +01001284 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001285 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001286 }
Nick Coghland6009512014-11-20 21:39:37 +10001287#endif /* Py_TRACE_REFS */
1288
1289 /* Clear interpreter state and all thread states. */
1290 PyInterpreterState_Clear(interp);
1291
1292 /* Now we decref the exception classes. After this point nothing
1293 can raise an exception. That's okay, because each Fini() method
1294 below has been checked to make sure no exceptions are ever
1295 raised.
1296 */
1297
1298 _PyExc_Fini();
1299
1300 /* Sundry finalizers */
1301 PyMethod_Fini();
1302 PyFrame_Fini();
1303 PyCFunction_Fini();
1304 PyTuple_Fini();
1305 PyList_Fini();
1306 PySet_Fini();
1307 PyBytes_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001308 PyLong_Fini();
1309 PyFloat_Fini();
1310 PyDict_Fini();
1311 PySlice_Fini();
Victor Stinner8e91c242019-04-24 17:24:01 +02001312 _PyGC_Fini(runtime);
Eric Snow86ea5812019-05-10 13:29:55 -04001313 _PyWarnings_Fini(interp);
Eric Snow6b4be192017-05-22 21:36:03 -07001314 _Py_HashRandomization_Fini();
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001315 _PyArg_Fini();
Yury Selivanoveb636452016-09-08 22:01:51 -07001316 PyAsyncGen_Fini();
Yury Selivanovf23746a2018-01-22 19:11:18 -05001317 _PyContext_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001318
1319 /* Cleanup Unicode implementation */
1320 _PyUnicode_Fini();
1321
Victor Stinnerb2457ef2018-08-29 13:25:36 +02001322 _Py_ClearFileSystemEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10001323
1324 /* XXX Still allocated:
1325 - various static ad-hoc pointers to interned strings
1326 - int and float free list blocks
1327 - whatever various modules and libraries allocate
1328 */
1329
1330 PyGrammar_RemoveAccelerators(&_PyParser_Grammar);
1331
1332 /* Cleanup auto-thread-state */
Victor Stinner8e91c242019-04-24 17:24:01 +02001333 _PyGILState_Fini(runtime);
Nick Coghland6009512014-11-20 21:39:37 +10001334
1335 /* Delete current thread. After this, many C API calls become crashy. */
1336 PyThreadState_Swap(NULL);
Victor Stinner8a1be612016-03-14 22:07:55 +01001337
Nick Coghland6009512014-11-20 21:39:37 +10001338 PyInterpreterState_Delete(interp);
1339
1340#ifdef Py_TRACE_REFS
1341 /* Display addresses (& refcnts) of all objects still alive.
1342 * An address can be used to find the repr of the object, printed
1343 * above by _Py_PrintReferences.
1344 */
Victor Stinnerda273412017-12-15 01:46:02 +01001345 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001346 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001347 }
Nick Coghland6009512014-11-20 21:39:37 +10001348#endif /* Py_TRACE_REFS */
Victor Stinner34be807c2016-03-14 12:04:26 +01001349#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001350 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001351 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be807c2016-03-14 12:04:26 +01001352 }
Nick Coghland6009512014-11-20 21:39:37 +10001353#endif
1354
Victor Stinner8e91c242019-04-24 17:24:01 +02001355 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001356
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001357 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001358 return status;
1359}
1360
1361void
1362Py_Finalize(void)
1363{
1364 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001365}
1366
1367/* Create and initialize a new interpreter and thread, and return the
1368 new thread. This requires that Py_Initialize() has been called
1369 first.
1370
1371 Unsuccessful initialization yields a NULL pointer. Note that *no*
1372 exception information is available even in this case -- the
1373 exception information is held in the thread, and there is no
1374 thread.
1375
1376 Locking: as above.
1377
1378*/
1379
Victor Stinner331a6a52019-05-27 16:39:22 +02001380static PyStatus
Victor Stinnera7368ac2017-11-15 18:11:45 -08001381new_interpreter(PyThreadState **tstate_p)
Nick Coghland6009512014-11-20 21:39:37 +10001382{
Victor Stinner331a6a52019-05-27 16:39:22 +02001383 PyStatus status;
Nick Coghland6009512014-11-20 21:39:37 +10001384
Victor Stinner331a6a52019-05-27 16:39:22 +02001385 status = _PyRuntime_Initialize();
1386 if (_PyStatus_EXCEPTION(status)) {
1387 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001388 }
1389 _PyRuntimeState *runtime = &_PyRuntime;
1390
1391 if (!runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001392 return _PyStatus_ERR("Py_Initialize must be called first");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001393 }
Nick Coghland6009512014-11-20 21:39:37 +10001394
Victor Stinner8a1be612016-03-14 22:07:55 +01001395 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1396 interpreters: disable PyGILState_Check(). */
1397 _PyGILState_check_enabled = 0;
1398
Victor Stinner43125222019-04-24 18:23:53 +02001399 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001400 if (interp == NULL) {
1401 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001402 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001403 }
Nick Coghland6009512014-11-20 21:39:37 +10001404
Victor Stinner43125222019-04-24 18:23:53 +02001405 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001406 if (tstate == NULL) {
1407 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001408 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001409 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001410 }
1411
Victor Stinner43125222019-04-24 18:23:53 +02001412 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001413
Eric Snow1abcf672017-05-23 21:46:51 -07001414 /* Copy the current interpreter config into the new interpreter */
Victor Stinner331a6a52019-05-27 16:39:22 +02001415 PyConfig *config;
Eric Snow1abcf672017-05-23 21:46:51 -07001416 if (save_tstate != NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001417 config = &save_tstate->interp->config;
Eric Snow1abcf672017-05-23 21:46:51 -07001418 } else {
1419 /* No current thread state, copy from the main interpreter */
1420 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinner331a6a52019-05-27 16:39:22 +02001421 config = &main_interp->config;
Victor Stinnerda273412017-12-15 01:46:02 +01001422 }
1423
Victor Stinner331a6a52019-05-27 16:39:22 +02001424 status = _PyConfig_Copy(&interp->config, config);
1425 if (_PyStatus_EXCEPTION(status)) {
1426 return status;
Victor Stinnerda273412017-12-15 01:46:02 +01001427 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001428 config = &interp->config;
Eric Snow1abcf672017-05-23 21:46:51 -07001429
Victor Stinner331a6a52019-05-27 16:39:22 +02001430 status = _PyExc_Init();
1431 if (_PyStatus_EXCEPTION(status)) {
1432 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001433 }
1434
Victor Stinner331a6a52019-05-27 16:39:22 +02001435 status = _PyErr_Init();
1436 if (_PyStatus_EXCEPTION(status)) {
1437 return status;
Victor Stinneref9d9b62019-05-22 11:28:22 +02001438 }
1439
1440
Nick Coghland6009512014-11-20 21:39:37 +10001441 /* XXX The following is lax in error checking */
Eric Snowd393c1b2017-09-14 12:18:12 -06001442 PyObject *modules = PyDict_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001443 if (modules == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001444 return _PyStatus_ERR("can't make modules dictionary");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001445 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001446 interp->modules = modules;
Nick Coghland6009512014-11-20 21:39:37 +10001447
Victor Stinner43125222019-04-24 18:23:53 +02001448 PyObject *sysmod = _PyImport_FindBuiltin("sys", modules);
Eric Snowd393c1b2017-09-14 12:18:12 -06001449 if (sysmod != NULL) {
1450 interp->sysdict = PyModule_GetDict(sysmod);
Victor Stinner43125222019-04-24 18:23:53 +02001451 if (interp->sysdict == NULL) {
Eric Snowd393c1b2017-09-14 12:18:12 -06001452 goto handle_error;
Victor Stinner43125222019-04-24 18:23:53 +02001453 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001454 Py_INCREF(interp->sysdict);
1455 PyDict_SetItemString(interp->sysdict, "modules", modules);
Victor Stinner43125222019-04-24 18:23:53 +02001456 if (_PySys_InitMain(runtime, interp) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001457 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerab672812019-01-23 15:04:40 +01001458 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001459 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001460 else if (PyErr_Occurred()) {
1461 goto handle_error;
1462 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001463
Victor Stinner43125222019-04-24 18:23:53 +02001464 PyObject *bimod = _PyImport_FindBuiltin("builtins", modules);
Nick Coghland6009512014-11-20 21:39:37 +10001465 if (bimod != NULL) {
1466 interp->builtins = PyModule_GetDict(bimod);
1467 if (interp->builtins == NULL)
1468 goto handle_error;
1469 Py_INCREF(interp->builtins);
1470 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001471 else if (PyErr_Occurred()) {
1472 goto handle_error;
1473 }
Nick Coghland6009512014-11-20 21:39:37 +10001474
Nick Coghland6009512014-11-20 21:39:37 +10001475 if (bimod != NULL && sysmod != NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001476 status = _PyBuiltins_AddExceptions(bimod);
1477 if (_PyStatus_EXCEPTION(status)) {
1478 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001479 }
Nick Coghland6009512014-11-20 21:39:37 +10001480
Victor Stinner331a6a52019-05-27 16:39:22 +02001481 status = _PySys_SetPreliminaryStderr(interp->sysdict);
1482 if (_PyStatus_EXCEPTION(status)) {
1483 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001484 }
Nick Coghland6009512014-11-20 21:39:37 +10001485
Victor Stinner331a6a52019-05-27 16:39:22 +02001486 status = _PyImportHooks_Init();
1487 if (_PyStatus_EXCEPTION(status)) {
1488 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001489 }
Nick Coghland6009512014-11-20 21:39:37 +10001490
Victor Stinner331a6a52019-05-27 16:39:22 +02001491 status = init_importlib(interp, sysmod);
1492 if (_PyStatus_EXCEPTION(status)) {
1493 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001494 }
Nick Coghland6009512014-11-20 21:39:37 +10001495
Victor Stinner331a6a52019-05-27 16:39:22 +02001496 status = init_importlib_external(interp);
1497 if (_PyStatus_EXCEPTION(status)) {
1498 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001499 }
Nick Coghland6009512014-11-20 21:39:37 +10001500
Victor Stinner331a6a52019-05-27 16:39:22 +02001501 status = _PyUnicode_InitEncodings(interp);
1502 if (_PyStatus_EXCEPTION(status)) {
1503 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001504 }
1505
Victor Stinner331a6a52019-05-27 16:39:22 +02001506 status = init_sys_streams(interp);
1507 if (_PyStatus_EXCEPTION(status)) {
1508 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001509 }
1510
Victor Stinner331a6a52019-05-27 16:39:22 +02001511 status = add_main_module(interp);
1512 if (_PyStatus_EXCEPTION(status)) {
1513 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001514 }
1515
Victor Stinner331a6a52019-05-27 16:39:22 +02001516 if (config->site_import) {
1517 status = init_import_size();
1518 if (_PyStatus_EXCEPTION(status)) {
1519 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001520 }
1521 }
Nick Coghland6009512014-11-20 21:39:37 +10001522 }
1523
Victor Stinnera7368ac2017-11-15 18:11:45 -08001524 if (PyErr_Occurred()) {
1525 goto handle_error;
1526 }
Nick Coghland6009512014-11-20 21:39:37 +10001527
Victor Stinnera7368ac2017-11-15 18:11:45 -08001528 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +02001529 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001530
Nick Coghland6009512014-11-20 21:39:37 +10001531handle_error:
1532 /* Oops, it didn't work. Undo it all. */
1533
1534 PyErr_PrintEx(0);
1535 PyThreadState_Clear(tstate);
1536 PyThreadState_Swap(save_tstate);
1537 PyThreadState_Delete(tstate);
1538 PyInterpreterState_Delete(interp);
1539
Victor Stinnera7368ac2017-11-15 18:11:45 -08001540 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001541 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001542}
1543
1544PyThreadState *
1545Py_NewInterpreter(void)
1546{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001547 PyThreadState *tstate = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001548 PyStatus status = new_interpreter(&tstate);
1549 if (_PyStatus_EXCEPTION(status)) {
1550 Py_ExitStatusException(status);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001551 }
1552 return tstate;
1553
Nick Coghland6009512014-11-20 21:39:37 +10001554}
1555
1556/* Delete an interpreter and its last thread. This requires that the
1557 given thread state is current, that the thread has no remaining
1558 frames, and that it is its interpreter's only remaining thread.
1559 It is a fatal error to violate these constraints.
1560
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001561 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001562 everything, regardless.)
1563
1564 Locking: as above.
1565
1566*/
1567
1568void
1569Py_EndInterpreter(PyThreadState *tstate)
1570{
1571 PyInterpreterState *interp = tstate->interp;
1572
Victor Stinner50b48572018-11-01 01:51:40 +01001573 if (tstate != _PyThreadState_GET())
Nick Coghland6009512014-11-20 21:39:37 +10001574 Py_FatalError("Py_EndInterpreter: thread is not current");
1575 if (tstate->frame != NULL)
1576 Py_FatalError("Py_EndInterpreter: thread still has a frame");
Eric Snow5be45a62019-03-08 22:47:07 -07001577 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001578
Eric Snow842a2f02019-03-15 15:47:51 -06001579 // Wrap up existing "threading"-module-created, non-daemon threads.
Nick Coghland6009512014-11-20 21:39:37 +10001580 wait_for_thread_shutdown();
1581
Marcel Plch776407f2017-12-20 11:17:58 +01001582 call_py_exitfuncs(interp);
1583
Nick Coghland6009512014-11-20 21:39:37 +10001584 if (tstate != interp->tstate_head || tstate->next != NULL)
1585 Py_FatalError("Py_EndInterpreter: not the last thread");
1586
1587 PyImport_Cleanup();
1588 PyInterpreterState_Clear(interp);
1589 PyThreadState_Swap(NULL);
1590 PyInterpreterState_Delete(interp);
1591}
1592
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001593/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001594
Victor Stinner331a6a52019-05-27 16:39:22 +02001595static PyStatus
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001596add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001597{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001598 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001599 m = PyImport_AddModule("__main__");
1600 if (m == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +02001601 return _PyStatus_ERR("can't create __main__ module");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001602
Nick Coghland6009512014-11-20 21:39:37 +10001603 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001604 ann_dict = PyDict_New();
1605 if ((ann_dict == NULL) ||
1606 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001607 return _PyStatus_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001608 }
1609 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001610
Nick Coghland6009512014-11-20 21:39:37 +10001611 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1612 PyObject *bimod = PyImport_ImportModule("builtins");
1613 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001614 return _PyStatus_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001615 }
1616 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001617 return _PyStatus_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001618 }
1619 Py_DECREF(bimod);
1620 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001621
Nick Coghland6009512014-11-20 21:39:37 +10001622 /* Main is a little special - imp.is_builtin("__main__") will return
1623 * False, but BuiltinImporter is still the most appropriate initial
1624 * setting for its __loader__ attribute. A more suitable value will
1625 * be set if __main__ gets further initialized later in the startup
1626 * process.
1627 */
1628 loader = PyDict_GetItemString(d, "__loader__");
1629 if (loader == NULL || loader == Py_None) {
1630 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1631 "BuiltinImporter");
1632 if (loader == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001633 return _PyStatus_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001634 }
1635 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001636 return _PyStatus_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001637 }
1638 Py_DECREF(loader);
1639 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001640 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001641}
1642
Nick Coghland6009512014-11-20 21:39:37 +10001643/* Import the site module (not into __main__ though) */
1644
Victor Stinner331a6a52019-05-27 16:39:22 +02001645static PyStatus
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001646init_import_size(void)
Nick Coghland6009512014-11-20 21:39:37 +10001647{
1648 PyObject *m;
1649 m = PyImport_ImportModule("site");
1650 if (m == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001651 return _PyStatus_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001652 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001653 Py_DECREF(m);
Victor Stinner331a6a52019-05-27 16:39:22 +02001654 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001655}
1656
Victor Stinner874dbe82015-09-04 17:29:57 +02001657/* Check if a file descriptor is valid or not.
1658 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1659static int
1660is_valid_fd(int fd)
1661{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001662/* dup() is faster than fstat(): fstat() can require input/output operations,
1663 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1664 startup. Problem: dup() doesn't check if the file descriptor is valid on
1665 some platforms.
1666
1667 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1668 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1669 EBADF. FreeBSD has similar issue (bpo-32849).
1670
1671 Only use dup() on platforms where dup() is enough to detect invalid FD in
1672 corner cases: on Linux and Windows (bpo-32849). */
1673#if defined(__linux__) || defined(MS_WINDOWS)
1674 if (fd < 0) {
1675 return 0;
1676 }
1677 int fd2;
1678
1679 _Py_BEGIN_SUPPRESS_IPH
1680 fd2 = dup(fd);
1681 if (fd2 >= 0) {
1682 close(fd2);
1683 }
1684 _Py_END_SUPPRESS_IPH
1685
1686 return (fd2 >= 0);
1687#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001688 struct stat st;
1689 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001690#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001691}
1692
1693/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001694static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02001695create_stdio(const PyConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001696 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001697 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001698{
1699 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1700 const char* mode;
1701 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001702 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001703 int buffering, isatty;
1704 _Py_IDENTIFIER(open);
1705 _Py_IDENTIFIER(isatty);
1706 _Py_IDENTIFIER(TextIOWrapper);
1707 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001708 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001709
Victor Stinner874dbe82015-09-04 17:29:57 +02001710 if (!is_valid_fd(fd))
1711 Py_RETURN_NONE;
1712
Nick Coghland6009512014-11-20 21:39:37 +10001713 /* stdin is always opened in buffered mode, first because it shouldn't
1714 make a difference in common use cases, second because TextIOWrapper
1715 depends on the presence of a read1() method which only exists on
1716 buffered streams.
1717 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001718 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001719 buffering = 0;
1720 else
1721 buffering = -1;
1722 if (write_mode)
1723 mode = "wb";
1724 else
1725 mode = "rb";
1726 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOi",
1727 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001728 Py_None, Py_None, /* encoding, errors */
1729 Py_None, 0); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001730 if (buf == NULL)
1731 goto error;
1732
1733 if (buffering) {
1734 _Py_IDENTIFIER(raw);
1735 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1736 if (raw == NULL)
1737 goto error;
1738 }
1739 else {
1740 raw = buf;
1741 Py_INCREF(raw);
1742 }
1743
Steve Dower39294992016-08-30 21:22:36 -07001744#ifdef MS_WINDOWS
1745 /* Windows console IO is always UTF-8 encoded */
1746 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001747 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001748#endif
1749
Nick Coghland6009512014-11-20 21:39:37 +10001750 text = PyUnicode_FromString(name);
1751 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1752 goto error;
Victor Stinner3466bde2016-09-05 18:16:01 -07001753 res = _PyObject_CallMethodId(raw, &PyId_isatty, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10001754 if (res == NULL)
1755 goto error;
1756 isatty = PyObject_IsTrue(res);
1757 Py_DECREF(res);
1758 if (isatty == -1)
1759 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001760 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001761 write_through = Py_True;
1762 else
1763 write_through = Py_False;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001764 if (isatty && buffered_stdio)
Nick Coghland6009512014-11-20 21:39:37 +10001765 line_buffering = Py_True;
1766 else
1767 line_buffering = Py_False;
1768
1769 Py_CLEAR(raw);
1770 Py_CLEAR(text);
1771
1772#ifdef MS_WINDOWS
1773 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1774 newlines to "\n".
1775 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1776 newline = NULL;
1777#else
1778 /* sys.stdin: split lines at "\n".
1779 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1780 newline = "\n";
1781#endif
1782
Victor Stinner709d23d2019-05-02 14:56:30 -04001783 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1784 if (encoding_str == NULL) {
1785 Py_CLEAR(buf);
1786 goto error;
1787 }
1788
1789 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1790 if (errors_str == NULL) {
1791 Py_CLEAR(buf);
1792 Py_CLEAR(encoding_str);
1793 goto error;
1794 }
1795
1796 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1797 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001798 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001799 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001800 Py_CLEAR(encoding_str);
1801 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001802 if (stream == NULL)
1803 goto error;
1804
1805 if (write_mode)
1806 mode = "w";
1807 else
1808 mode = "r";
1809 text = PyUnicode_FromString(mode);
1810 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1811 goto error;
1812 Py_CLEAR(text);
1813 return stream;
1814
1815error:
1816 Py_XDECREF(buf);
1817 Py_XDECREF(stream);
1818 Py_XDECREF(text);
1819 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001820
Victor Stinner874dbe82015-09-04 17:29:57 +02001821 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1822 /* Issue #24891: the file descriptor was closed after the first
1823 is_valid_fd() check was called. Ignore the OSError and set the
1824 stream to None. */
1825 PyErr_Clear();
1826 Py_RETURN_NONE;
1827 }
1828 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001829}
1830
1831/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinner331a6a52019-05-27 16:39:22 +02001832static PyStatus
Victor Stinner91106cd2017-12-13 12:29:09 +01001833init_sys_streams(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001834{
1835 PyObject *iomod = NULL, *wrapper;
1836 PyObject *bimod = NULL;
1837 PyObject *m;
1838 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001839 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001840 PyObject * encoding_attr;
Victor Stinner331a6a52019-05-27 16:39:22 +02001841 PyStatus res = _PyStatus_OK();
1842 PyConfig *config = &interp->config;
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001843
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001844 /* Check that stdin is not a directory
1845 Using shell redirection, you can redirect stdin to a directory,
1846 crashing the Python interpreter. Catch this common mistake here
1847 and output a useful error message. Note that under MS Windows,
1848 the shell already prevents that. */
1849#ifndef MS_WINDOWS
1850 struct _Py_stat_struct sb;
1851 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1852 S_ISDIR(sb.st_mode)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001853 return _PyStatus_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001854 }
1855#endif
1856
Nick Coghland6009512014-11-20 21:39:37 +10001857 /* Hack to avoid a nasty recursion issue when Python is invoked
1858 in verbose mode: pre-import the Latin-1 and UTF-8 codecs */
1859 if ((m = PyImport_ImportModule("encodings.utf_8")) == NULL) {
1860 goto error;
1861 }
1862 Py_DECREF(m);
1863
1864 if (!(m = PyImport_ImportModule("encodings.latin_1"))) {
1865 goto error;
1866 }
1867 Py_DECREF(m);
1868
1869 if (!(bimod = PyImport_ImportModule("builtins"))) {
1870 goto error;
1871 }
1872
1873 if (!(iomod = PyImport_ImportModule("io"))) {
1874 goto error;
1875 }
1876 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1877 goto error;
1878 }
1879
1880 /* Set builtins.open */
1881 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1882 Py_DECREF(wrapper);
1883 goto error;
1884 }
1885 Py_DECREF(wrapper);
1886
Nick Coghland6009512014-11-20 21:39:37 +10001887 /* Set sys.stdin */
1888 fd = fileno(stdin);
1889 /* Under some conditions stdin, stdout and stderr may not be connected
1890 * and fileno() may point to an invalid file descriptor. For example
1891 * GUI apps don't have valid standard streams by default.
1892 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001893 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001894 config->stdio_encoding,
1895 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001896 if (std == NULL)
1897 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001898 PySys_SetObject("__stdin__", std);
1899 _PySys_SetObjectId(&PyId_stdin, std);
1900 Py_DECREF(std);
1901
1902 /* Set sys.stdout */
1903 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001904 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001905 config->stdio_encoding,
1906 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001907 if (std == NULL)
1908 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001909 PySys_SetObject("__stdout__", std);
1910 _PySys_SetObjectId(&PyId_stdout, std);
1911 Py_DECREF(std);
1912
1913#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
1914 /* Set sys.stderr, replaces the preliminary stderr */
1915 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001916 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001917 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04001918 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02001919 if (std == NULL)
1920 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001921
1922 /* Same as hack above, pre-import stderr's codec to avoid recursion
1923 when import.c tries to write to stderr in verbose mode. */
1924 encoding_attr = PyObject_GetAttrString(std, "encoding");
1925 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001926 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10001927 if (std_encoding != NULL) {
1928 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
1929 Py_XDECREF(codec_info);
1930 }
1931 Py_DECREF(encoding_attr);
1932 }
1933 PyErr_Clear(); /* Not a fatal error if codec isn't available */
1934
1935 if (PySys_SetObject("__stderr__", std) < 0) {
1936 Py_DECREF(std);
1937 goto error;
1938 }
1939 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
1940 Py_DECREF(std);
1941 goto error;
1942 }
1943 Py_DECREF(std);
1944#endif
1945
Victor Stinnera7368ac2017-11-15 18:11:45 -08001946 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10001947
Victor Stinnera7368ac2017-11-15 18:11:45 -08001948error:
Victor Stinner331a6a52019-05-27 16:39:22 +02001949 res = _PyStatus_ERR("can't initialize sys standard streams");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001950
1951done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02001952 _Py_ClearStandardStreamEncoding();
Victor Stinner31e99082017-12-20 23:41:38 +01001953
Nick Coghland6009512014-11-20 21:39:37 +10001954 Py_XDECREF(bimod);
1955 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001956 return res;
Nick Coghland6009512014-11-20 21:39:37 +10001957}
1958
1959
Victor Stinner10dc4842015-03-24 12:01:30 +01001960static void
Victor Stinner791da1c2016-03-14 16:53:12 +01001961_Py_FatalError_DumpTracebacks(int fd)
Victor Stinner10dc4842015-03-24 12:01:30 +01001962{
Victor Stinner10dc4842015-03-24 12:01:30 +01001963 fputc('\n', stderr);
1964 fflush(stderr);
1965
1966 /* display the current Python stack */
Victor Stinner861d9ab2016-03-16 22:45:24 +01001967 _Py_DumpTracebackThreads(fd, NULL, NULL);
Victor Stinner10dc4842015-03-24 12:01:30 +01001968}
Victor Stinner791da1c2016-03-14 16:53:12 +01001969
1970/* Print the current exception (if an exception is set) with its traceback,
1971 or display the current Python stack.
1972
1973 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
1974 called on catastrophic cases.
1975
1976 Return 1 if the traceback was displayed, 0 otherwise. */
1977
1978static int
1979_Py_FatalError_PrintExc(int fd)
1980{
1981 PyObject *ferr, *res;
1982 PyObject *exception, *v, *tb;
1983 int has_tb;
1984
Victor Stinner791da1c2016-03-14 16:53:12 +01001985 PyErr_Fetch(&exception, &v, &tb);
1986 if (exception == NULL) {
1987 /* No current exception */
1988 return 0;
1989 }
1990
1991 ferr = _PySys_GetObjectId(&PyId_stderr);
1992 if (ferr == NULL || ferr == Py_None) {
1993 /* sys.stderr is not set yet or set to None,
1994 no need to try to display the exception */
1995 return 0;
1996 }
1997
1998 PyErr_NormalizeException(&exception, &v, &tb);
1999 if (tb == NULL) {
2000 tb = Py_None;
2001 Py_INCREF(tb);
2002 }
2003 PyException_SetTraceback(v, tb);
2004 if (exception == NULL) {
2005 /* PyErr_NormalizeException() failed */
2006 return 0;
2007 }
2008
2009 has_tb = (tb != Py_None);
2010 PyErr_Display(exception, v, tb);
2011 Py_XDECREF(exception);
2012 Py_XDECREF(v);
2013 Py_XDECREF(tb);
2014
2015 /* sys.stderr may be buffered: call sys.stderr.flush() */
Victor Stinner3466bde2016-09-05 18:16:01 -07002016 res = _PyObject_CallMethodId(ferr, &PyId_flush, NULL);
Victor Stinner791da1c2016-03-14 16:53:12 +01002017 if (res == NULL)
2018 PyErr_Clear();
2019 else
2020 Py_DECREF(res);
2021
2022 return has_tb;
2023}
2024
Nick Coghland6009512014-11-20 21:39:37 +10002025/* Print fatal error message and abort */
2026
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002027#ifdef MS_WINDOWS
2028static void
2029fatal_output_debug(const char *msg)
2030{
2031 /* buffer of 256 bytes allocated on the stack */
2032 WCHAR buffer[256 / sizeof(WCHAR)];
2033 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2034 size_t msglen;
2035
2036 OutputDebugStringW(L"Fatal Python error: ");
2037
2038 msglen = strlen(msg);
2039 while (msglen) {
2040 size_t i;
2041
2042 if (buflen > msglen) {
2043 buflen = msglen;
2044 }
2045
2046 /* Convert the message to wchar_t. This uses a simple one-to-one
2047 conversion, assuming that the this error message actually uses
2048 ASCII only. If this ceases to be true, we will have to convert. */
2049 for (i=0; i < buflen; ++i) {
2050 buffer[i] = msg[i];
2051 }
2052 buffer[i] = L'\0';
2053 OutputDebugStringW(buffer);
2054
2055 msg += buflen;
2056 msglen -= buflen;
2057 }
2058 OutputDebugStringW(L"\n");
2059}
2060#endif
2061
Benjamin Petersoncef88b92017-11-25 13:02:55 -08002062static void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002063fatal_error(const char *prefix, const char *msg, int status)
Nick Coghland6009512014-11-20 21:39:37 +10002064{
2065 const int fd = fileno(stderr);
Victor Stinner53345a42015-03-25 01:55:14 +01002066 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002067
2068 if (reentrant) {
2069 /* Py_FatalError() caused a second fatal error.
2070 Example: flush_std_files() raises a recursion error. */
2071 goto exit;
2072 }
2073 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002074
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002075 fprintf(stderr, "Fatal Python error: ");
2076 if (prefix) {
2077 fputs(prefix, stderr);
2078 fputs(": ", stderr);
2079 }
2080 if (msg) {
2081 fputs(msg, stderr);
2082 }
2083 else {
2084 fprintf(stderr, "<message not set>");
2085 }
2086 fputs("\n", stderr);
Nick Coghland6009512014-11-20 21:39:37 +10002087 fflush(stderr); /* it helps in Windows debug build */
Victor Stinner10dc4842015-03-24 12:01:30 +01002088
Victor Stinner3a228ab2018-11-01 00:26:41 +01002089 /* Check if the current thread has a Python thread state
2090 and holds the GIL */
2091 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2092 if (tss_tstate != NULL) {
Victor Stinner50b48572018-11-01 01:51:40 +01002093 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner3a228ab2018-11-01 00:26:41 +01002094 if (tss_tstate != tstate) {
2095 /* The Python thread does not hold the GIL */
2096 tss_tstate = NULL;
2097 }
2098 }
2099 else {
2100 /* Py_FatalError() has been called from a C thread
2101 which has no Python thread state. */
2102 }
2103 int has_tstate_and_gil = (tss_tstate != NULL);
2104
2105 if (has_tstate_and_gil) {
2106 /* If an exception is set, print the exception with its traceback */
2107 if (!_Py_FatalError_PrintExc(fd)) {
2108 /* No exception is set, or an exception is set without traceback */
2109 _Py_FatalError_DumpTracebacks(fd);
2110 }
2111 }
2112 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002113 _Py_FatalError_DumpTracebacks(fd);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002114 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002115
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002116 /* The main purpose of faulthandler is to display the traceback.
2117 This function already did its best to display a traceback.
2118 Disable faulthandler to prevent writing a second traceback
2119 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002120 _PyFaulthandler_Fini();
2121
Victor Stinner791da1c2016-03-14 16:53:12 +01002122 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002123 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002124 /* Flush sys.stdout and sys.stderr */
2125 flush_std_files();
2126 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002127
Nick Coghland6009512014-11-20 21:39:37 +10002128#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002129 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002130#endif /* MS_WINDOWS */
2131
2132exit:
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002133 if (status < 0) {
Victor Stinner53345a42015-03-25 01:55:14 +01002134#if defined(MS_WINDOWS) && defined(_DEBUG)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002135 DebugBreak();
Nick Coghland6009512014-11-20 21:39:37 +10002136#endif
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002137 abort();
2138 }
2139 else {
2140 exit(status);
2141 }
2142}
2143
Victor Stinner19760862017-12-20 01:41:59 +01002144void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002145Py_FatalError(const char *msg)
2146{
2147 fatal_error(NULL, msg, -1);
2148}
2149
Victor Stinner19760862017-12-20 01:41:59 +01002150void _Py_NO_RETURN
Victor Stinner331a6a52019-05-27 16:39:22 +02002151Py_ExitStatusException(PyStatus status)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002152{
Victor Stinner331a6a52019-05-27 16:39:22 +02002153 if (_PyStatus_IS_EXIT(status)) {
2154 exit(status.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002155 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002156 else if (_PyStatus_IS_ERROR(status)) {
2157 fatal_error(status.func, status.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002158 }
2159 else {
Victor Stinner331a6a52019-05-27 16:39:22 +02002160 Py_FatalError("Py_ExitStatusException() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002161 }
Nick Coghland6009512014-11-20 21:39:37 +10002162}
2163
2164/* Clean up and exit */
2165
Victor Stinnerd7292b52016-06-17 12:29:00 +02002166# include "pythread.h"
Nick Coghland6009512014-11-20 21:39:37 +10002167
Nick Coghland6009512014-11-20 21:39:37 +10002168/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002169void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002170{
Victor Stinnercaba55b2018-08-03 15:33:52 +02002171 PyInterpreterState *is = _PyInterpreterState_Get();
Marcel Plch776407f2017-12-20 11:17:58 +01002172
Antoine Pitroufc5db952017-12-13 02:29:07 +01002173 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002174 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2175
2176 is->pyexitfunc = func;
2177 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002178}
2179
2180static void
Marcel Plch776407f2017-12-20 11:17:58 +01002181call_py_exitfuncs(PyInterpreterState *istate)
Nick Coghland6009512014-11-20 21:39:37 +10002182{
Marcel Plch776407f2017-12-20 11:17:58 +01002183 if (istate->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002184 return;
2185
Marcel Plch776407f2017-12-20 11:17:58 +01002186 (*istate->pyexitfunc)(istate->pyexitmodule);
Nick Coghland6009512014-11-20 21:39:37 +10002187 PyErr_Clear();
2188}
2189
2190/* Wait until threading._shutdown completes, provided
2191 the threading module was imported in the first place.
2192 The shutdown routine will wait until all non-daemon
2193 "threading" threads have completed. */
2194static void
2195wait_for_thread_shutdown(void)
2196{
Nick Coghland6009512014-11-20 21:39:37 +10002197 _Py_IDENTIFIER(_shutdown);
2198 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002199 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002200 if (threading == NULL) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002201 if (PyErr_Occurred()) {
2202 PyErr_WriteUnraisable(NULL);
2203 }
2204 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002205 return;
2206 }
Victor Stinner3466bde2016-09-05 18:16:01 -07002207 result = _PyObject_CallMethodId(threading, &PyId__shutdown, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10002208 if (result == NULL) {
2209 PyErr_WriteUnraisable(threading);
2210 }
2211 else {
2212 Py_DECREF(result);
2213 }
2214 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002215}
2216
2217#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002218int Py_AtExit(void (*func)(void))
2219{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002220 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002221 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002222 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002223 return 0;
2224}
2225
2226static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002227call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002228{
Victor Stinner8e91c242019-04-24 17:24:01 +02002229 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002230 /* pop last function from the list */
2231 runtime->nexitfuncs--;
2232 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2233 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2234
2235 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002236 }
Nick Coghland6009512014-11-20 21:39:37 +10002237
2238 fflush(stdout);
2239 fflush(stderr);
2240}
2241
Victor Stinnercfc88312018-08-01 16:41:25 +02002242void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002243Py_Exit(int sts)
2244{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002245 if (Py_FinalizeEx() < 0) {
2246 sts = 120;
2247 }
Nick Coghland6009512014-11-20 21:39:37 +10002248
2249 exit(sts);
2250}
2251
Victor Stinner331a6a52019-05-27 16:39:22 +02002252static PyStatus
Victor Stinner43fc3bb2019-05-02 11:54:20 -04002253init_signals(void)
Nick Coghland6009512014-11-20 21:39:37 +10002254{
2255#ifdef SIGPIPE
2256 PyOS_setsig(SIGPIPE, SIG_IGN);
2257#endif
2258#ifdef SIGXFZ
2259 PyOS_setsig(SIGXFZ, SIG_IGN);
2260#endif
2261#ifdef SIGXFSZ
2262 PyOS_setsig(SIGXFSZ, SIG_IGN);
2263#endif
2264 PyOS_InitInterrupts(); /* May imply initsignal() */
2265 if (PyErr_Occurred()) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002266 return _PyStatus_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002267 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002268 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002269}
2270
2271
2272/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2273 *
2274 * All of the code in this function must only use async-signal-safe functions,
2275 * listed at `man 7 signal` or
2276 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2277 */
2278void
2279_Py_RestoreSignals(void)
2280{
2281#ifdef SIGPIPE
2282 PyOS_setsig(SIGPIPE, SIG_DFL);
2283#endif
2284#ifdef SIGXFZ
2285 PyOS_setsig(SIGXFZ, SIG_DFL);
2286#endif
2287#ifdef SIGXFSZ
2288 PyOS_setsig(SIGXFSZ, SIG_DFL);
2289#endif
2290}
2291
2292
2293/*
2294 * The file descriptor fd is considered ``interactive'' if either
2295 * a) isatty(fd) is TRUE, or
2296 * b) the -i flag was given, and the filename associated with
2297 * the descriptor is NULL or "<stdin>" or "???".
2298 */
2299int
2300Py_FdIsInteractive(FILE *fp, const char *filename)
2301{
2302 if (isatty((int)fileno(fp)))
2303 return 1;
2304 if (!Py_InteractiveFlag)
2305 return 0;
2306 return (filename == NULL) ||
2307 (strcmp(filename, "<stdin>") == 0) ||
2308 (strcmp(filename, "???") == 0);
2309}
2310
2311
Nick Coghland6009512014-11-20 21:39:37 +10002312/* Wrappers around sigaction() or signal(). */
2313
2314PyOS_sighandler_t
2315PyOS_getsig(int sig)
2316{
2317#ifdef HAVE_SIGACTION
2318 struct sigaction context;
2319 if (sigaction(sig, NULL, &context) == -1)
2320 return SIG_ERR;
2321 return context.sa_handler;
2322#else
2323 PyOS_sighandler_t handler;
2324/* Special signal handling for the secure CRT in Visual Studio 2005 */
2325#if defined(_MSC_VER) && _MSC_VER >= 1400
2326 switch (sig) {
2327 /* Only these signals are valid */
2328 case SIGINT:
2329 case SIGILL:
2330 case SIGFPE:
2331 case SIGSEGV:
2332 case SIGTERM:
2333 case SIGBREAK:
2334 case SIGABRT:
2335 break;
2336 /* Don't call signal() with other values or it will assert */
2337 default:
2338 return SIG_ERR;
2339 }
2340#endif /* _MSC_VER && _MSC_VER >= 1400 */
2341 handler = signal(sig, SIG_IGN);
2342 if (handler != SIG_ERR)
2343 signal(sig, handler);
2344 return handler;
2345#endif
2346}
2347
2348/*
2349 * All of the code in this function must only use async-signal-safe functions,
2350 * listed at `man 7 signal` or
2351 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2352 */
2353PyOS_sighandler_t
2354PyOS_setsig(int sig, PyOS_sighandler_t handler)
2355{
2356#ifdef HAVE_SIGACTION
2357 /* Some code in Modules/signalmodule.c depends on sigaction() being
2358 * used here if HAVE_SIGACTION is defined. Fix that if this code
2359 * changes to invalidate that assumption.
2360 */
2361 struct sigaction context, ocontext;
2362 context.sa_handler = handler;
2363 sigemptyset(&context.sa_mask);
2364 context.sa_flags = 0;
2365 if (sigaction(sig, &context, &ocontext) == -1)
2366 return SIG_ERR;
2367 return ocontext.sa_handler;
2368#else
2369 PyOS_sighandler_t oldhandler;
2370 oldhandler = signal(sig, handler);
2371#ifdef HAVE_SIGINTERRUPT
2372 siginterrupt(sig, 1);
2373#endif
2374 return oldhandler;
2375#endif
2376}
2377
2378#ifdef __cplusplus
2379}
2380#endif