blob: ea89b3a626bd33c248220fe44b23edc4c0561e48 [file] [log] [blame]
Nick Coghland6009512014-11-20 21:39:37 +10001/* Python interpreter top-level routines, including init/exit */
2
3#include "Python.h"
4
5#include "Python-ast.h"
Victor Stinner3bb183d2018-11-22 18:38:38 +01006#undef Yield /* undefine macro conflicting with <winbase.h> */
Victor Stinner09532fe2019-05-10 23:39:09 +02007#include "pycore_ceval.h"
Victor Stinner99fcc612019-04-29 13:04:07 +02008#include "pycore_context.h"
Victor Stinner0a28f8d2019-06-19 02:54:39 +02009#include "pycore_import.h" /* _PyImport_FindBuiltin */
Victor Stinner331a6a52019-05-27 16:39:22 +020010#include "pycore_initconfig.h"
Victor Stinner353933e2018-11-23 13:08:26 +010011#include "pycore_fileutils.h"
Victor Stinner27e2d1f2018-11-01 00:52:28 +010012#include "pycore_hamt.h"
Victor Stinnera1c249c2018-11-01 03:15:58 +010013#include "pycore_pathconfig.h"
Victor Stinnerb45d2592019-06-20 00:05:23 +020014#include "pycore_pyerrors.h"
Victor Stinner621cebe2018-11-12 16:53:38 +010015#include "pycore_pylifecycle.h"
16#include "pycore_pymem.h"
17#include "pycore_pystate.h"
Victor Stinnered488662019-05-20 00:14:57 +020018#include "pycore_traceback.h"
Nick Coghland6009512014-11-20 21:39:37 +100019#include "grammar.h"
20#include "node.h"
21#include "token.h"
22#include "parsetok.h"
23#include "errcode.h"
24#include "code.h"
25#include "symtable.h"
26#include "ast.h"
27#include "marshal.h"
28#include "osdefs.h"
29#include <locale.h>
30
31#ifdef HAVE_SIGNAL_H
32#include <signal.h>
33#endif
34
35#ifdef MS_WINDOWS
36#include "malloc.h" /* for alloca */
37#endif
38
39#ifdef HAVE_LANGINFO_H
40#include <langinfo.h>
41#endif
42
43#ifdef MS_WINDOWS
44#undef BYTE
45#include "windows.h"
Steve Dower39294992016-08-30 21:22:36 -070046
47extern PyTypeObject PyWindowsConsoleIO_Type;
48#define PyWindowsConsoleIO_Check(op) (PyObject_TypeCheck((op), &PyWindowsConsoleIO_Type))
Nick Coghland6009512014-11-20 21:39:37 +100049#endif
50
51_Py_IDENTIFIER(flush);
52_Py_IDENTIFIER(name);
53_Py_IDENTIFIER(stdin);
54_Py_IDENTIFIER(stdout);
55_Py_IDENTIFIER(stderr);
Eric Snow3f9eee62017-09-15 16:35:20 -060056_Py_IDENTIFIER(threading);
Nick Coghland6009512014-11-20 21:39:37 +100057
58#ifdef __cplusplus
59extern "C" {
60#endif
61
Nick Coghland6009512014-11-20 21:39:37 +100062extern grammar _PyParser_Grammar; /* From graminit.c */
63
Victor Stinnerb45d2592019-06-20 00:05:23 +020064/* Forward declarations */
Victor Stinner331a6a52019-05-27 16:39:22 +020065static PyStatus add_main_module(PyInterpreterState *interp);
Victor Stinnerb45d2592019-06-20 00:05:23 +020066static PyStatus init_import_site(void);
67static PyStatus init_sys_streams(PyThreadState *tstate);
68static PyStatus init_signals(PyThreadState *tstate);
69static void call_py_exitfuncs(PyThreadState *tstate);
70static void wait_for_thread_shutdown(PyThreadState *tstate);
Victor Stinner8e91c242019-04-24 17:24:01 +020071static void call_ll_exitfuncs(_PyRuntimeState *runtime);
Nick Coghland6009512014-11-20 21:39:37 +100072
Gregory P. Smith38f11cc2019-02-16 12:57:40 -080073int _Py_UnhandledKeyboardInterrupt = 0;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080074_PyRuntimeState _PyRuntime = _PyRuntimeState_INIT;
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010075static int runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060076
Victor Stinner331a6a52019-05-27 16:39:22 +020077PyStatus
Eric Snow2ebc5ce2017-09-07 23:51:28 -060078_PyRuntime_Initialize(void)
79{
80 /* XXX We only initialize once in the process, which aligns with
81 the static initialization of the former globals now found in
82 _PyRuntime. However, _PyRuntime *should* be initialized with
83 every Py_Initialize() call, but doing so breaks the runtime.
84 This is because the runtime state is not properly finalized
85 currently. */
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010086 if (runtime_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +020087 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -080088 }
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010089 runtime_initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080090
91 return _PyRuntimeState_Init(&_PyRuntime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -060092}
93
94void
95_PyRuntime_Finalize(void)
96{
97 _PyRuntimeState_Fini(&_PyRuntime);
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010098 runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060099}
100
101int
102_Py_IsFinalizing(void)
103{
104 return _PyRuntime.finalizing != NULL;
105}
106
Nick Coghland6009512014-11-20 21:39:37 +1000107/* Hack to force loading of object files */
108int (*_PyOS_mystrnicmp_hack)(const char *, const char *, Py_ssize_t) = \
109 PyOS_mystrnicmp; /* Python/pystrcmp.o */
110
111/* PyModule_GetWarningsModule is no longer necessary as of 2.6
112since _warnings is builtin. This API should not be used. */
113PyObject *
114PyModule_GetWarningsModule(void)
115{
116 return PyImport_ImportModule("warnings");
117}
118
Eric Snowc7ec9982017-05-23 23:00:52 -0700119
Eric Snow1abcf672017-05-23 21:46:51 -0700120/* APIs to access the initialization flags
121 *
122 * Can be called prior to Py_Initialize.
123 */
Nick Coghland6009512014-11-20 21:39:37 +1000124
Eric Snow1abcf672017-05-23 21:46:51 -0700125int
126_Py_IsCoreInitialized(void)
127{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600128 return _PyRuntime.core_initialized;
Eric Snow1abcf672017-05-23 21:46:51 -0700129}
Nick Coghland6009512014-11-20 21:39:37 +1000130
131int
132Py_IsInitialized(void)
133{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600134 return _PyRuntime.initialized;
Nick Coghland6009512014-11-20 21:39:37 +1000135}
136
Nick Coghlan6ea41862017-06-11 13:16:15 +1000137
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000138/* Global initializations. Can be undone by Py_FinalizeEx(). Don't
139 call this twice without an intervening Py_FinalizeEx() call. When
Nick Coghland6009512014-11-20 21:39:37 +1000140 initializations fail, a fatal error is issued and the function does
141 not return. On return, the first thread and interpreter state have
142 been created.
143
144 Locking: you must hold the interpreter lock while calling this.
145 (If the lock has not yet been initialized, that's equivalent to
146 having the lock, but you cannot use multiple threads.)
147
148*/
149
Victor Stinner331a6a52019-05-27 16:39:22 +0200150static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200151init_importlib(PyThreadState *tstate, PyObject *sysmod)
Nick Coghland6009512014-11-20 21:39:37 +1000152{
153 PyObject *importlib;
154 PyObject *impmod;
Nick Coghland6009512014-11-20 21:39:37 +1000155 PyObject *value;
Victor Stinnerb45d2592019-06-20 00:05:23 +0200156 PyInterpreterState *interp = tstate->interp;
Victor Stinner331a6a52019-05-27 16:39:22 +0200157 int verbose = interp->config.verbose;
Nick Coghland6009512014-11-20 21:39:37 +1000158
159 /* Import _importlib through its frozen version, _frozen_importlib. */
160 if (PyImport_ImportFrozenModule("_frozen_importlib") <= 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200161 return _PyStatus_ERR("can't import _frozen_importlib");
Nick Coghland6009512014-11-20 21:39:37 +1000162 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200163 else if (verbose) {
Nick Coghland6009512014-11-20 21:39:37 +1000164 PySys_FormatStderr("import _frozen_importlib # frozen\n");
165 }
166 importlib = PyImport_AddModule("_frozen_importlib");
167 if (importlib == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200168 return _PyStatus_ERR("couldn't get _frozen_importlib from sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000169 }
170 interp->importlib = importlib;
171 Py_INCREF(interp->importlib);
172
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300173 interp->import_func = PyDict_GetItemString(interp->builtins, "__import__");
174 if (interp->import_func == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +0200175 return _PyStatus_ERR("__import__ not found");
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300176 Py_INCREF(interp->import_func);
177
Victor Stinnercd6e6942015-09-18 09:11:57 +0200178 /* Import the _imp module */
Benjamin Petersonc65ef772018-01-29 11:33:57 -0800179 impmod = PyInit__imp();
Nick Coghland6009512014-11-20 21:39:37 +1000180 if (impmod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200181 return _PyStatus_ERR("can't import _imp");
Nick Coghland6009512014-11-20 21:39:37 +1000182 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200183 else if (verbose) {
Victor Stinnercd6e6942015-09-18 09:11:57 +0200184 PySys_FormatStderr("import _imp # builtin\n");
Nick Coghland6009512014-11-20 21:39:37 +1000185 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600186 if (_PyImport_SetModuleString("_imp", impmod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200187 return _PyStatus_ERR("can't save _imp to sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000188 }
189
Victor Stinnercd6e6942015-09-18 09:11:57 +0200190 /* Install importlib as the implementation of import */
Nick Coghland6009512014-11-20 21:39:37 +1000191 value = PyObject_CallMethod(importlib, "_install", "OO", sysmod, impmod);
192 if (value == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200193 _PyErr_Print(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200194 return _PyStatus_ERR("importlib install failed");
Nick Coghland6009512014-11-20 21:39:37 +1000195 }
196 Py_DECREF(value);
197 Py_DECREF(impmod);
198
Victor Stinner331a6a52019-05-27 16:39:22 +0200199 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000200}
201
Victor Stinner331a6a52019-05-27 16:39:22 +0200202static PyStatus
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200203init_importlib_external(PyThreadState *tstate)
Eric Snow1abcf672017-05-23 21:46:51 -0700204{
205 PyObject *value;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200206 value = PyObject_CallMethod(tstate->interp->importlib,
Eric Snow1abcf672017-05-23 21:46:51 -0700207 "_install_external_importers", "");
208 if (value == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200209 _PyErr_Print(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200210 return _PyStatus_ERR("external importer setup failed");
Eric Snow1abcf672017-05-23 21:46:51 -0700211 }
Stéphane Wirtelab1cb802017-06-08 13:13:20 +0200212 Py_DECREF(value);
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200213 return _PyImportZip_Init(tstate);
Eric Snow1abcf672017-05-23 21:46:51 -0700214}
Nick Coghland6009512014-11-20 21:39:37 +1000215
Nick Coghlan6ea41862017-06-11 13:16:15 +1000216/* Helper functions to better handle the legacy C locale
217 *
218 * The legacy C locale assumes ASCII as the default text encoding, which
219 * causes problems not only for the CPython runtime, but also other
220 * components like GNU readline.
221 *
222 * Accordingly, when the CLI detects it, it attempts to coerce it to a
223 * more capable UTF-8 based alternative as follows:
224 *
225 * if (_Py_LegacyLocaleDetected()) {
226 * _Py_CoerceLegacyLocale();
227 * }
228 *
229 * See the documentation of the PYTHONCOERCECLOCALE setting for more details.
230 *
231 * Locale coercion also impacts the default error handler for the standard
232 * streams: while the usual default is "strict", the default for the legacy
233 * C locale and for any of the coercion target locales is "surrogateescape".
234 */
235
236int
Victor Stinner0f721472019-05-20 17:16:38 +0200237_Py_LegacyLocaleDetected(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000238{
239#ifndef MS_WINDOWS
Victor Stinner0f721472019-05-20 17:16:38 +0200240 if (!warn) {
241 const char *locale_override = getenv("LC_ALL");
242 if (locale_override != NULL && *locale_override != '\0') {
243 /* Don't coerce C locale if the LC_ALL environment variable
244 is set */
245 return 0;
246 }
247 }
248
Nick Coghlan6ea41862017-06-11 13:16:15 +1000249 /* On non-Windows systems, the C locale is considered a legacy locale */
Nick Coghlaneb817952017-06-18 12:29:42 +1000250 /* XXX (ncoghlan): some platforms (notably Mac OS X) don't appear to treat
251 * the POSIX locale as a simple alias for the C locale, so
252 * we may also want to check for that explicitly.
253 */
Nick Coghlan6ea41862017-06-11 13:16:15 +1000254 const char *ctype_loc = setlocale(LC_CTYPE, NULL);
255 return ctype_loc != NULL && strcmp(ctype_loc, "C") == 0;
256#else
257 /* Windows uses code pages instead of locales, so no locale is legacy */
258 return 0;
259#endif
260}
261
Nick Coghlaneb817952017-06-18 12:29:42 +1000262static const char *_C_LOCALE_WARNING =
263 "Python runtime initialized with LC_CTYPE=C (a locale with default ASCII "
264 "encoding), which may cause Unicode compatibility problems. Using C.UTF-8, "
265 "C.utf8, or UTF-8 (if available) as alternative Unicode-compatible "
266 "locales is recommended.\n";
267
Nick Coghlaneb817952017-06-18 12:29:42 +1000268static void
Victor Stinner43125222019-04-24 18:23:53 +0200269emit_stderr_warning_for_legacy_locale(_PyRuntimeState *runtime)
Nick Coghlaneb817952017-06-18 12:29:42 +1000270{
Victor Stinner331a6a52019-05-27 16:39:22 +0200271 const PyPreConfig *preconfig = &runtime->preconfig;
Victor Stinner0f721472019-05-20 17:16:38 +0200272 if (preconfig->coerce_c_locale_warn && _Py_LegacyLocaleDetected(1)) {
Victor Stinnercf215042018-08-29 22:56:06 +0200273 PySys_FormatStderr("%s", _C_LOCALE_WARNING);
Nick Coghlaneb817952017-06-18 12:29:42 +1000274 }
275}
276
Nick Coghlan6ea41862017-06-11 13:16:15 +1000277typedef struct _CandidateLocale {
278 const char *locale_name; /* The locale to try as a coercion target */
279} _LocaleCoercionTarget;
280
281static _LocaleCoercionTarget _TARGET_LOCALES[] = {
282 {"C.UTF-8"},
283 {"C.utf8"},
Nick Coghlan18974c32017-06-30 00:48:14 +1000284 {"UTF-8"},
Nick Coghlan6ea41862017-06-11 13:16:15 +1000285 {NULL}
286};
287
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200288
289int
290_Py_IsLocaleCoercionTarget(const char *ctype_loc)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000291{
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200292 const _LocaleCoercionTarget *target = NULL;
293 for (target = _TARGET_LOCALES; target->locale_name; target++) {
294 if (strcmp(ctype_loc, target->locale_name) == 0) {
295 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000296 }
Victor Stinner124b9eb2018-08-29 01:29:06 +0200297 }
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200298 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000299}
300
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200301
Nick Coghlan6ea41862017-06-11 13:16:15 +1000302#ifdef PY_COERCE_C_LOCALE
Victor Stinner94540602017-12-16 04:54:22 +0100303static const char C_LOCALE_COERCION_WARNING[] =
Nick Coghlan6ea41862017-06-11 13:16:15 +1000304 "Python detected LC_CTYPE=C: LC_CTYPE coerced to %.20s (set another locale "
305 "or PYTHONCOERCECLOCALE=0 to disable this locale coercion behavior).\n";
306
Victor Stinner0f721472019-05-20 17:16:38 +0200307static int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200308_coerce_default_locale_settings(int warn, const _LocaleCoercionTarget *target)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000309{
310 const char *newloc = target->locale_name;
311
312 /* Reset locale back to currently configured defaults */
xdegaye1588be62017-11-12 12:45:59 +0100313 _Py_SetLocaleFromEnv(LC_ALL);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000314
315 /* Set the relevant locale environment variable */
316 if (setenv("LC_CTYPE", newloc, 1)) {
317 fprintf(stderr,
318 "Error setting LC_CTYPE, skipping C locale coercion\n");
Victor Stinner0f721472019-05-20 17:16:38 +0200319 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000320 }
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200321 if (warn) {
Victor Stinner94540602017-12-16 04:54:22 +0100322 fprintf(stderr, C_LOCALE_COERCION_WARNING, newloc);
Nick Coghlaneb817952017-06-18 12:29:42 +1000323 }
Nick Coghlan6ea41862017-06-11 13:16:15 +1000324
325 /* Reconfigure with the overridden environment variables */
xdegaye1588be62017-11-12 12:45:59 +0100326 _Py_SetLocaleFromEnv(LC_ALL);
Victor Stinner0f721472019-05-20 17:16:38 +0200327 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000328}
329#endif
330
Victor Stinner0f721472019-05-20 17:16:38 +0200331int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200332_Py_CoerceLegacyLocale(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000333{
Victor Stinner0f721472019-05-20 17:16:38 +0200334 int coerced = 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000335#ifdef PY_COERCE_C_LOCALE
Victor Stinner8ea09112018-09-03 17:05:18 +0200336 char *oldloc = NULL;
337
338 oldloc = _PyMem_RawStrdup(setlocale(LC_CTYPE, NULL));
339 if (oldloc == NULL) {
Victor Stinner0f721472019-05-20 17:16:38 +0200340 return coerced;
Victor Stinner8ea09112018-09-03 17:05:18 +0200341 }
342
Victor Stinner94540602017-12-16 04:54:22 +0100343 const char *locale_override = getenv("LC_ALL");
344 if (locale_override == NULL || *locale_override == '\0') {
345 /* LC_ALL is also not set (or is set to an empty string) */
346 const _LocaleCoercionTarget *target = NULL;
347 for (target = _TARGET_LOCALES; target->locale_name; target++) {
348 const char *new_locale = setlocale(LC_CTYPE,
349 target->locale_name);
350 if (new_locale != NULL) {
Victor Stinnere2510952019-05-02 11:28:57 -0400351#if !defined(_Py_FORCE_UTF8_LOCALE) && defined(HAVE_LANGINFO_H) && defined(CODESET)
Victor Stinner94540602017-12-16 04:54:22 +0100352 /* Also ensure that nl_langinfo works in this locale */
353 char *codeset = nl_langinfo(CODESET);
354 if (!codeset || *codeset == '\0') {
355 /* CODESET is not set or empty, so skip coercion */
356 new_locale = NULL;
357 _Py_SetLocaleFromEnv(LC_CTYPE);
358 continue;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000359 }
Victor Stinner94540602017-12-16 04:54:22 +0100360#endif
361 /* Successfully configured locale, so make it the default */
Victor Stinner0f721472019-05-20 17:16:38 +0200362 coerced = _coerce_default_locale_settings(warn, target);
Victor Stinner8ea09112018-09-03 17:05:18 +0200363 goto done;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000364 }
365 }
366 }
367 /* No C locale warning here, as Py_Initialize will emit one later */
Victor Stinner8ea09112018-09-03 17:05:18 +0200368
369 setlocale(LC_CTYPE, oldloc);
370
371done:
372 PyMem_RawFree(oldloc);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000373#endif
Victor Stinner0f721472019-05-20 17:16:38 +0200374 return coerced;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000375}
376
xdegaye1588be62017-11-12 12:45:59 +0100377/* _Py_SetLocaleFromEnv() is a wrapper around setlocale(category, "") to
378 * isolate the idiosyncrasies of different libc implementations. It reads the
379 * appropriate environment variable and uses its value to select the locale for
380 * 'category'. */
381char *
382_Py_SetLocaleFromEnv(int category)
383{
Victor Stinner353933e2018-11-23 13:08:26 +0100384 char *res;
xdegaye1588be62017-11-12 12:45:59 +0100385#ifdef __ANDROID__
386 const char *locale;
387 const char **pvar;
388#ifdef PY_COERCE_C_LOCALE
389 const char *coerce_c_locale;
390#endif
391 const char *utf8_locale = "C.UTF-8";
392 const char *env_var_set[] = {
393 "LC_ALL",
394 "LC_CTYPE",
395 "LANG",
396 NULL,
397 };
398
399 /* Android setlocale(category, "") doesn't check the environment variables
400 * and incorrectly sets the "C" locale at API 24 and older APIs. We only
401 * check the environment variables listed in env_var_set. */
402 for (pvar=env_var_set; *pvar; pvar++) {
403 locale = getenv(*pvar);
404 if (locale != NULL && *locale != '\0') {
405 if (strcmp(locale, utf8_locale) == 0 ||
406 strcmp(locale, "en_US.UTF-8") == 0) {
407 return setlocale(category, utf8_locale);
408 }
409 return setlocale(category, "C");
410 }
411 }
412
413 /* Android uses UTF-8, so explicitly set the locale to C.UTF-8 if none of
414 * LC_ALL, LC_CTYPE, or LANG is set to a non-empty string.
415 * Quote from POSIX section "8.2 Internationalization Variables":
416 * "4. If the LANG environment variable is not set or is set to the empty
417 * string, the implementation-defined default locale shall be used." */
418
419#ifdef PY_COERCE_C_LOCALE
420 coerce_c_locale = getenv("PYTHONCOERCECLOCALE");
421 if (coerce_c_locale == NULL || strcmp(coerce_c_locale, "0") != 0) {
422 /* Some other ported code may check the environment variables (e.g. in
423 * extension modules), so we make sure that they match the locale
424 * configuration */
425 if (setenv("LC_CTYPE", utf8_locale, 1)) {
426 fprintf(stderr, "Warning: failed setting the LC_CTYPE "
427 "environment variable to %s\n", utf8_locale);
428 }
429 }
430#endif
Victor Stinner353933e2018-11-23 13:08:26 +0100431 res = setlocale(category, utf8_locale);
432#else /* !defined(__ANDROID__) */
433 res = setlocale(category, "");
434#endif
435 _Py_ResetForceASCII();
436 return res;
xdegaye1588be62017-11-12 12:45:59 +0100437}
438
Nick Coghlan6ea41862017-06-11 13:16:15 +1000439
Eric Snow1abcf672017-05-23 21:46:51 -0700440/* Global initializations. Can be undone by Py_Finalize(). Don't
441 call this twice without an intervening Py_Finalize() call.
442
Victor Stinner331a6a52019-05-27 16:39:22 +0200443 Every call to Py_InitializeFromConfig, Py_Initialize or Py_InitializeEx
Eric Snow1abcf672017-05-23 21:46:51 -0700444 must have a corresponding call to Py_Finalize.
445
446 Locking: you must hold the interpreter lock while calling these APIs.
447 (If the lock has not yet been initialized, that's equivalent to
448 having the lock, but you cannot use multiple threads.)
449
450*/
451
Victor Stinner331a6a52019-05-27 16:39:22 +0200452static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200453pyinit_core_reconfigure(_PyRuntimeState *runtime,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200454 PyThreadState **tstate_p,
Victor Stinner331a6a52019-05-27 16:39:22 +0200455 const PyConfig *config)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200456{
Victor Stinner331a6a52019-05-27 16:39:22 +0200457 PyStatus status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100458 PyThreadState *tstate = _PyThreadState_GET();
459 if (!tstate) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200460 return _PyStatus_ERR("failed to read thread state");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100461 }
Victor Stinnerb45d2592019-06-20 00:05:23 +0200462 *tstate_p = tstate;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100463
464 PyInterpreterState *interp = tstate->interp;
465 if (interp == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200466 return _PyStatus_ERR("can't make main interpreter");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100467 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100468
Victor Stinner331a6a52019-05-27 16:39:22 +0200469 _PyConfig_Write(config, runtime);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200470
Victor Stinner331a6a52019-05-27 16:39:22 +0200471 status = _PyConfig_Copy(&interp->config, config);
472 if (_PyStatus_EXCEPTION(status)) {
473 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200474 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200475 config = &interp->config;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200476
Victor Stinner331a6a52019-05-27 16:39:22 +0200477 if (config->_install_importlib) {
478 status = _PyConfig_SetPathConfig(config);
479 if (_PyStatus_EXCEPTION(status)) {
480 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200481 }
482 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200483 return _PyStatus_OK();
Victor Stinner1dc6e392018-07-25 02:49:17 +0200484}
485
486
Victor Stinner331a6a52019-05-27 16:39:22 +0200487static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200488pycore_init_runtime(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200489 const PyConfig *config)
Nick Coghland6009512014-11-20 21:39:37 +1000490{
Victor Stinner43125222019-04-24 18:23:53 +0200491 if (runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200492 return _PyStatus_ERR("main interpreter already initialized");
Victor Stinner1dc6e392018-07-25 02:49:17 +0200493 }
Victor Stinnerda273412017-12-15 01:46:02 +0100494
Victor Stinner331a6a52019-05-27 16:39:22 +0200495 _PyConfig_Write(config, runtime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600496
Eric Snow1abcf672017-05-23 21:46:51 -0700497 /* Py_Finalize leaves _Py_Finalizing set in order to help daemon
498 * threads behave a little more gracefully at interpreter shutdown.
499 * We clobber it here so the new interpreter can start with a clean
500 * slate.
501 *
502 * However, this may still lead to misbehaviour if there are daemon
503 * threads still hanging around from a previous Py_Initialize/Finalize
504 * pair :(
505 */
Victor Stinner43125222019-04-24 18:23:53 +0200506 runtime->finalizing = NULL;
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600507
Victor Stinner331a6a52019-05-27 16:39:22 +0200508 PyStatus status = _Py_HashRandomization_Init(config);
509 if (_PyStatus_EXCEPTION(status)) {
510 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800511 }
512
Victor Stinner331a6a52019-05-27 16:39:22 +0200513 status = _PyInterpreterState_Enable(runtime);
514 if (_PyStatus_EXCEPTION(status)) {
515 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -0800516 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200517 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100518}
Victor Stinnera7368ac2017-11-15 18:11:45 -0800519
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100520
Victor Stinner331a6a52019-05-27 16:39:22 +0200521static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200522pycore_create_interpreter(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200523 const PyConfig *config,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200524 PyThreadState **tstate_p)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100525{
526 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnerda273412017-12-15 01:46:02 +0100527 if (interp == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200528 return _PyStatus_ERR("can't make main interpreter");
Victor Stinnerda273412017-12-15 01:46:02 +0100529 }
530
Victor Stinner331a6a52019-05-27 16:39:22 +0200531 PyStatus status = _PyConfig_Copy(&interp->config, config);
532 if (_PyStatus_EXCEPTION(status)) {
533 return status;
Victor Stinnerda273412017-12-15 01:46:02 +0100534 }
Nick Coghland6009512014-11-20 21:39:37 +1000535
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200536 PyThreadState *tstate = PyThreadState_New(interp);
Victor Stinnerb45d2592019-06-20 00:05:23 +0200537 if (tstate == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200538 return _PyStatus_ERR("can't make first thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +0200539 }
Nick Coghland6009512014-11-20 21:39:37 +1000540 (void) PyThreadState_Swap(tstate);
541
Victor Stinner99fcc612019-04-29 13:04:07 +0200542 /* We can't call _PyEval_FiniThreads() in Py_FinalizeEx because
543 destroying the GIL might fail when it is being referenced from
544 another running thread (see issue #9901).
Nick Coghland6009512014-11-20 21:39:37 +1000545 Instead we destroy the previously created GIL here, which ensures
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000546 that we can call Py_Initialize / Py_FinalizeEx multiple times. */
Victor Stinner09532fe2019-05-10 23:39:09 +0200547 _PyEval_FiniThreads(&runtime->ceval);
Victor Stinner2914bb32018-01-29 11:57:45 +0100548
Nick Coghland6009512014-11-20 21:39:37 +1000549 /* Auto-thread-state API */
Victor Stinnerb45d2592019-06-20 00:05:23 +0200550 _PyGILState_Init(runtime, tstate);
Nick Coghland6009512014-11-20 21:39:37 +1000551
Victor Stinner2914bb32018-01-29 11:57:45 +0100552 /* Create the GIL */
553 PyEval_InitThreads();
554
Victor Stinnerb45d2592019-06-20 00:05:23 +0200555 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +0200556 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100557}
Nick Coghland6009512014-11-20 21:39:37 +1000558
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100559
Victor Stinner331a6a52019-05-27 16:39:22 +0200560static PyStatus
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100561pycore_init_types(void)
562{
Victor Stinner331a6a52019-05-27 16:39:22 +0200563 PyStatus status = _PyTypes_Init();
564 if (_PyStatus_EXCEPTION(status)) {
565 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100566 }
567
Victor Stinner331a6a52019-05-27 16:39:22 +0200568 status = _PyUnicode_Init();
569 if (_PyStatus_EXCEPTION(status)) {
570 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100571 }
572
573 if (_PyStructSequence_Init() < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200574 return _PyStatus_ERR("can't initialize structseq");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100575 }
576
577 if (!_PyLong_Init()) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200578 return _PyStatus_ERR("can't init longs");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100579 }
Nick Coghland6009512014-11-20 21:39:37 +1000580
Victor Stinner331a6a52019-05-27 16:39:22 +0200581 status = _PyExc_Init();
582 if (_PyStatus_EXCEPTION(status)) {
583 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100584 }
585
586 if (!_PyFloat_Init()) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200587 return _PyStatus_ERR("can't init float");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100588 }
Nick Coghland6009512014-11-20 21:39:37 +1000589
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100590 if (!_PyContext_Init()) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200591 return _PyStatus_ERR("can't init context");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100592 }
Victor Stinneref9d9b62019-05-22 11:28:22 +0200593
Victor Stinner331a6a52019-05-27 16:39:22 +0200594 status = _PyErr_Init();
595 if (_PyStatus_EXCEPTION(status)) {
596 return status;
Victor Stinneref9d9b62019-05-22 11:28:22 +0200597 }
598
Victor Stinner331a6a52019-05-27 16:39:22 +0200599 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100600}
601
602
Victor Stinner331a6a52019-05-27 16:39:22 +0200603static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200604pycore_init_builtins(PyThreadState *tstate)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100605{
Victor Stinnerb45d2592019-06-20 00:05:23 +0200606 PyInterpreterState *interp = tstate->interp;
607
608 PyObject *bimod = _PyBuiltin_Init(tstate);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100609 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200610 return _PyStatus_ERR("can't initialize builtins modules");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100611 }
612 _PyImport_FixupBuiltin(bimod, "builtins", interp->modules);
613
614 interp->builtins = PyModule_GetDict(bimod);
615 if (interp->builtins == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200616 return _PyStatus_ERR("can't initialize builtins dict");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100617 }
618 Py_INCREF(interp->builtins);
619
Victor Stinner331a6a52019-05-27 16:39:22 +0200620 PyStatus status = _PyBuiltins_AddExceptions(bimod);
621 if (_PyStatus_EXCEPTION(status)) {
622 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100623 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200624 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100625}
626
627
Victor Stinner331a6a52019-05-27 16:39:22 +0200628static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200629pycore_init_import_warnings(PyThreadState *tstate, PyObject *sysmod)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100630{
Victor Stinnerb45d2592019-06-20 00:05:23 +0200631 const PyConfig *config = &tstate->interp->config;
632
633 PyStatus status = _PyImport_Init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200634 if (_PyStatus_EXCEPTION(status)) {
635 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800636 }
Nick Coghland6009512014-11-20 21:39:37 +1000637
Victor Stinnerb45d2592019-06-20 00:05:23 +0200638 status = _PyImportHooks_Init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200639 if (_PyStatus_EXCEPTION(status)) {
640 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800641 }
Nick Coghland6009512014-11-20 21:39:37 +1000642
643 /* Initialize _warnings. */
Victor Stinner5d862462017-12-19 11:35:58 +0100644 if (_PyWarnings_Init() == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200645 return _PyStatus_ERR("can't initialize warnings");
Victor Stinner1f151112017-11-23 10:43:14 +0100646 }
Nick Coghland6009512014-11-20 21:39:37 +1000647
Victor Stinnerb45d2592019-06-20 00:05:23 +0200648 if (config->_install_importlib) {
649 status = _PyConfig_SetPathConfig(config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200650 if (_PyStatus_EXCEPTION(status)) {
651 return status;
Victor Stinnerb1147e42018-07-21 02:06:16 +0200652 }
653 }
654
Eric Snow1abcf672017-05-23 21:46:51 -0700655 /* This call sets up builtin and frozen import support */
Victor Stinnerb45d2592019-06-20 00:05:23 +0200656 if (config->_install_importlib) {
657 status = init_importlib(tstate, sysmod);
Victor Stinner331a6a52019-05-27 16:39:22 +0200658 if (_PyStatus_EXCEPTION(status)) {
659 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800660 }
Eric Snow1abcf672017-05-23 21:46:51 -0700661 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200662 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100663}
664
665
Victor Stinner331a6a52019-05-27 16:39:22 +0200666static PyStatus
667pyinit_config(_PyRuntimeState *runtime,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200668 PyThreadState **tstate_p,
Victor Stinner331a6a52019-05-27 16:39:22 +0200669 const PyConfig *config)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100670{
Victor Stinner331a6a52019-05-27 16:39:22 +0200671 _PyConfig_Write(config, runtime);
Victor Stinner20004952019-03-26 02:31:11 +0100672
Victor Stinner331a6a52019-05-27 16:39:22 +0200673 PyStatus status = pycore_init_runtime(runtime, config);
674 if (_PyStatus_EXCEPTION(status)) {
675 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100676 }
677
Victor Stinnerb45d2592019-06-20 00:05:23 +0200678 PyThreadState *tstate;
679 status = pycore_create_interpreter(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200680 if (_PyStatus_EXCEPTION(status)) {
681 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100682 }
Victor Stinnerb45d2592019-06-20 00:05:23 +0200683 config = &tstate->interp->config;
684 *tstate_p = tstate;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100685
Victor Stinner331a6a52019-05-27 16:39:22 +0200686 status = pycore_init_types();
687 if (_PyStatus_EXCEPTION(status)) {
688 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100689 }
690
691 PyObject *sysmod;
Victor Stinnerb45d2592019-06-20 00:05:23 +0200692 status = _PySys_Create(runtime, tstate, &sysmod);
Victor Stinner331a6a52019-05-27 16:39:22 +0200693 if (_PyStatus_EXCEPTION(status)) {
694 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100695 }
696
Victor Stinnerb45d2592019-06-20 00:05:23 +0200697 status = pycore_init_builtins(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200698 if (_PyStatus_EXCEPTION(status)) {
699 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100700 }
701
Victor Stinnerb45d2592019-06-20 00:05:23 +0200702 status = pycore_init_import_warnings(tstate, sysmod);
Victor Stinner331a6a52019-05-27 16:39:22 +0200703 if (_PyStatus_EXCEPTION(status)) {
704 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100705 }
Eric Snow1abcf672017-05-23 21:46:51 -0700706
707 /* Only when we get here is the runtime core fully initialized */
Victor Stinner43125222019-04-24 18:23:53 +0200708 runtime->core_initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200709 return _PyStatus_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700710}
711
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100712
Victor Stinner331a6a52019-05-27 16:39:22 +0200713PyStatus
714_Py_PreInitializeFromPyArgv(const PyPreConfig *src_config, const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100715{
Victor Stinner331a6a52019-05-27 16:39:22 +0200716 PyStatus status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100717
Victor Stinner6d1c4672019-05-20 11:02:00 +0200718 if (src_config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200719 return _PyStatus_ERR("preinitialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +0200720 }
721
Victor Stinner331a6a52019-05-27 16:39:22 +0200722 status = _PyRuntime_Initialize();
723 if (_PyStatus_EXCEPTION(status)) {
724 return status;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100725 }
Victor Stinner43125222019-04-24 18:23:53 +0200726 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100727
Victor Stinner43125222019-04-24 18:23:53 +0200728 if (runtime->pre_initialized) {
Victor Stinnerf72346c2019-03-25 17:54:58 +0100729 /* If it's already configured: ignored the new configuration */
Victor Stinner331a6a52019-05-27 16:39:22 +0200730 return _PyStatus_OK();
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100731 }
732
Victor Stinner331a6a52019-05-27 16:39:22 +0200733 PyPreConfig config;
Victor Stinner6d1c4672019-05-20 11:02:00 +0200734 _PyPreConfig_InitFromPreConfig(&config, src_config);
Victor Stinnerf72346c2019-03-25 17:54:58 +0100735
Victor Stinner331a6a52019-05-27 16:39:22 +0200736 status = _PyPreConfig_Read(&config, args);
737 if (_PyStatus_EXCEPTION(status)) {
738 return status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100739 }
740
Victor Stinner331a6a52019-05-27 16:39:22 +0200741 status = _PyPreConfig_Write(&config);
742 if (_PyStatus_EXCEPTION(status)) {
743 return status;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100744 }
745
Victor Stinner43125222019-04-24 18:23:53 +0200746 runtime->pre_initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200747 return _PyStatus_OK();
Victor Stinnerf72346c2019-03-25 17:54:58 +0100748}
749
Victor Stinner70005ac2019-05-02 15:25:34 -0400750
Victor Stinner331a6a52019-05-27 16:39:22 +0200751PyStatus
752Py_PreInitializeFromBytesArgs(const PyPreConfig *src_config, Py_ssize_t argc, char **argv)
Victor Stinnerf72346c2019-03-25 17:54:58 +0100753{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100754 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400755 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100756}
757
758
Victor Stinner331a6a52019-05-27 16:39:22 +0200759PyStatus
760Py_PreInitializeFromArgs(const PyPreConfig *src_config, Py_ssize_t argc, wchar_t **argv)
Victor Stinner20004952019-03-26 02:31:11 +0100761{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100762 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400763 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinner20004952019-03-26 02:31:11 +0100764}
765
766
Victor Stinner331a6a52019-05-27 16:39:22 +0200767PyStatus
768Py_PreInitialize(const PyPreConfig *src_config)
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100769{
Victor Stinner70005ac2019-05-02 15:25:34 -0400770 return _Py_PreInitializeFromPyArgv(src_config, NULL);
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100771}
772
773
Victor Stinner331a6a52019-05-27 16:39:22 +0200774PyStatus
775_Py_PreInitializeFromConfig(const PyConfig *config,
776 const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100777{
Victor Stinner331a6a52019-05-27 16:39:22 +0200778 assert(config != NULL);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200779
Victor Stinner331a6a52019-05-27 16:39:22 +0200780 PyStatus status = _PyRuntime_Initialize();
781 if (_PyStatus_EXCEPTION(status)) {
782 return status;
Victor Stinner6d1c4672019-05-20 11:02:00 +0200783 }
784 _PyRuntimeState *runtime = &_PyRuntime;
785
786 if (runtime->pre_initialized) {
787 /* Already initialized: do nothing */
Victor Stinner331a6a52019-05-27 16:39:22 +0200788 return _PyStatus_OK();
Victor Stinner70005ac2019-05-02 15:25:34 -0400789 }
Victor Stinnercab5d072019-05-17 19:01:14 +0200790
Victor Stinner331a6a52019-05-27 16:39:22 +0200791 PyPreConfig preconfig;
792 _PyPreConfig_InitFromConfig(&preconfig, config);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200793
Victor Stinner331a6a52019-05-27 16:39:22 +0200794 if (!config->parse_argv) {
795 return Py_PreInitialize(&preconfig);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200796 }
797 else if (args == NULL) {
Victor Stinnercab5d072019-05-17 19:01:14 +0200798 _PyArgv config_args = {
799 .use_bytes_argv = 0,
Victor Stinner331a6a52019-05-27 16:39:22 +0200800 .argc = config->argv.length,
801 .wchar_argv = config->argv.items};
Victor Stinner6d1c4672019-05-20 11:02:00 +0200802 return _Py_PreInitializeFromPyArgv(&preconfig, &config_args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200803 }
804 else {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200805 return _Py_PreInitializeFromPyArgv(&preconfig, args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200806 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100807}
808
809
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100810/* Begin interpreter initialization
811 *
812 * On return, the first thread and interpreter state have been created,
813 * but the compiler, signal handling, multithreading and
814 * multiple interpreter support, and codec infrastructure are not yet
815 * available.
816 *
817 * The import system will support builtin and frozen modules only.
818 * The only supported io is writing to sys.stderr
819 *
820 * If any operation invoked by this function fails, a fatal error is
821 * issued and the function does not return.
822 *
823 * Any code invoked from this function should *not* assume it has access
824 * to the Python C API (unless the API is explicitly listed as being
825 * safe to call without calling Py_Initialize first)
826 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200827static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200828pyinit_core(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200829 const PyConfig *src_config,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200830 PyThreadState **tstate_p)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200831{
Victor Stinner331a6a52019-05-27 16:39:22 +0200832 PyStatus status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200833
Victor Stinner331a6a52019-05-27 16:39:22 +0200834 status = _Py_PreInitializeFromConfig(src_config, NULL);
835 if (_PyStatus_EXCEPTION(status)) {
836 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200837 }
838
Victor Stinner331a6a52019-05-27 16:39:22 +0200839 PyConfig config;
840 _PyConfig_InitCompatConfig(&config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200841
Victor Stinner331a6a52019-05-27 16:39:22 +0200842 status = _PyConfig_Copy(&config, src_config);
843 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200844 goto done;
845 }
846
Victor Stinner331a6a52019-05-27 16:39:22 +0200847 status = PyConfig_Read(&config);
848 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200849 goto done;
850 }
851
852 if (!runtime->core_initialized) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200853 status = pyinit_config(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200854 }
855 else {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200856 status = pyinit_core_reconfigure(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200857 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200858 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200859 goto done;
860 }
861
862done:
Victor Stinner331a6a52019-05-27 16:39:22 +0200863 PyConfig_Clear(&config);
864 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200865}
866
Victor Stinner5ac27a52019-03-27 13:40:14 +0100867
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200868/* Py_Initialize() has already been called: update the main interpreter
869 configuration. Example of bpo-34008: Py_Main() called after
870 Py_Initialize(). */
Victor Stinner331a6a52019-05-27 16:39:22 +0200871static PyStatus
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100872_Py_ReconfigureMainInterpreter(PyInterpreterState *interp)
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200873{
Victor Stinner331a6a52019-05-27 16:39:22 +0200874 PyConfig *config = &interp->config;
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100875
Victor Stinner331a6a52019-05-27 16:39:22 +0200876 PyObject *argv = _PyWideStringList_AsList(&config->argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100877 if (argv == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200878 return _PyStatus_NO_MEMORY(); \
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100879 }
880
881 int res = PyDict_SetItemString(interp->sysdict, "argv", argv);
882 Py_DECREF(argv);
883 if (res < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200884 return _PyStatus_ERR("fail to set sys.argv");
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200885 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200886 return _PyStatus_OK();
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200887}
888
Eric Snowc7ec9982017-05-23 23:00:52 -0700889/* Update interpreter state based on supplied configuration settings
890 *
891 * After calling this function, most of the restrictions on the interpreter
892 * are lifted. The only remaining incomplete settings are those related
893 * to the main module (sys.argv[0], __main__ metadata)
894 *
895 * Calling this when the interpreter is not initializing, is already
896 * initialized or without a valid current thread state is a fatal error.
897 * Other errors should be reported as normal Python exceptions with a
898 * non-zero return code.
899 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200900static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200901pyinit_main(_PyRuntimeState *runtime, PyThreadState *tstate)
Eric Snow1abcf672017-05-23 21:46:51 -0700902{
Victor Stinner43125222019-04-24 18:23:53 +0200903 if (!runtime->core_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200904 return _PyStatus_ERR("runtime core not initialized");
Eric Snowc7ec9982017-05-23 23:00:52 -0700905 }
Eric Snowc7ec9982017-05-23 23:00:52 -0700906
Victor Stinner1dc6e392018-07-25 02:49:17 +0200907 /* Configure the main interpreter */
Victor Stinnerb45d2592019-06-20 00:05:23 +0200908 PyInterpreterState *interp = tstate->interp;
Victor Stinner331a6a52019-05-27 16:39:22 +0200909 PyConfig *config = &interp->config;
Eric Snowc7ec9982017-05-23 23:00:52 -0700910
Victor Stinner43125222019-04-24 18:23:53 +0200911 if (runtime->initialized) {
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100912 return _Py_ReconfigureMainInterpreter(interp);
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200913 }
914
Victor Stinner331a6a52019-05-27 16:39:22 +0200915 if (!config->_install_importlib) {
Eric Snow1abcf672017-05-23 21:46:51 -0700916 /* Special mode for freeze_importlib: run with no import system
917 *
918 * This means anything which needs support from extension modules
919 * or pure Python code in the standard library won't work.
920 */
Victor Stinner43125222019-04-24 18:23:53 +0200921 runtime->initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200922 return _PyStatus_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700923 }
Victor Stinner9316ee42017-11-25 03:17:57 +0100924
Victor Stinner33c377e2017-12-05 15:12:41 +0100925 if (_PyTime_Init() < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200926 return _PyStatus_ERR("can't initialize time");
Victor Stinner33c377e2017-12-05 15:12:41 +0100927 }
Victor Stinner13019fd2015-04-03 13:10:54 +0200928
Victor Stinner838f2642019-06-13 22:41:23 +0200929 if (_PySys_InitMain(runtime, tstate) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200930 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerda273412017-12-15 01:46:02 +0100931 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800932
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200933 PyStatus status = init_importlib_external(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200934 if (_PyStatus_EXCEPTION(status)) {
935 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800936 }
Nick Coghland6009512014-11-20 21:39:37 +1000937
938 /* initialize the faulthandler module */
Victor Stinner331a6a52019-05-27 16:39:22 +0200939 status = _PyFaulthandler_Init(config->faulthandler);
940 if (_PyStatus_EXCEPTION(status)) {
941 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800942 }
Nick Coghland6009512014-11-20 21:39:37 +1000943
Victor Stinnerb45d2592019-06-20 00:05:23 +0200944 status = _PyUnicode_InitEncodings(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200945 if (_PyStatus_EXCEPTION(status)) {
946 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800947 }
Nick Coghland6009512014-11-20 21:39:37 +1000948
Victor Stinner331a6a52019-05-27 16:39:22 +0200949 if (config->install_signal_handlers) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200950 status = init_signals(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200951 if (_PyStatus_EXCEPTION(status)) {
952 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800953 }
954 }
Nick Coghland6009512014-11-20 21:39:37 +1000955
Victor Stinner331a6a52019-05-27 16:39:22 +0200956 if (_PyTraceMalloc_Init(config->tracemalloc) < 0) {
957 return _PyStatus_ERR("can't initialize tracemalloc");
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200958 }
Nick Coghland6009512014-11-20 21:39:37 +1000959
Victor Stinner331a6a52019-05-27 16:39:22 +0200960 status = add_main_module(interp);
961 if (_PyStatus_EXCEPTION(status)) {
962 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800963 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800964
Victor Stinnerb45d2592019-06-20 00:05:23 +0200965 status = init_sys_streams(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200966 if (_PyStatus_EXCEPTION(status)) {
967 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800968 }
Nick Coghland6009512014-11-20 21:39:37 +1000969
970 /* Initialize warnings. */
Victor Stinner37cd9822018-11-16 11:55:35 +0100971 PyObject *warnoptions = PySys_GetObject("warnoptions");
972 if (warnoptions != NULL && PyList_Size(warnoptions) > 0)
Victor Stinner5d862462017-12-19 11:35:58 +0100973 {
Nick Coghland6009512014-11-20 21:39:37 +1000974 PyObject *warnings_module = PyImport_ImportModule("warnings");
975 if (warnings_module == NULL) {
976 fprintf(stderr, "'import warnings' failed; traceback:\n");
Victor Stinnerb45d2592019-06-20 00:05:23 +0200977 _PyErr_Print(tstate);
Nick Coghland6009512014-11-20 21:39:37 +1000978 }
979 Py_XDECREF(warnings_module);
980 }
981
Victor Stinner43125222019-04-24 18:23:53 +0200982 runtime->initialized = 1;
Eric Snow1abcf672017-05-23 21:46:51 -0700983
Victor Stinner331a6a52019-05-27 16:39:22 +0200984 if (config->site_import) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200985 status = init_import_site();
Victor Stinner331a6a52019-05-27 16:39:22 +0200986 if (_PyStatus_EXCEPTION(status)) {
987 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800988 }
989 }
Victor Stinnercf215042018-08-29 22:56:06 +0200990
991#ifndef MS_WINDOWS
Victor Stinner43125222019-04-24 18:23:53 +0200992 emit_stderr_warning_for_legacy_locale(runtime);
Victor Stinnercf215042018-08-29 22:56:06 +0200993#endif
994
Victor Stinner331a6a52019-05-27 16:39:22 +0200995 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000996}
997
Victor Stinner9ef5dca2019-05-16 17:38:16 +0200998
Victor Stinner331a6a52019-05-27 16:39:22 +0200999PyStatus
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001000_Py_InitializeMain(void)
1001{
Victor Stinner331a6a52019-05-27 16:39:22 +02001002 PyStatus status = _PyRuntime_Initialize();
1003 if (_PyStatus_EXCEPTION(status)) {
1004 return status;
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001005 }
1006 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinnerb45d2592019-06-20 00:05:23 +02001007 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
1008 return pyinit_main(runtime, tstate);
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001009}
1010
1011
Victor Stinner331a6a52019-05-27 16:39:22 +02001012PyStatus
1013Py_InitializeFromConfig(const PyConfig *config)
Eric Snow1abcf672017-05-23 21:46:51 -07001014{
Victor Stinner6d1c4672019-05-20 11:02:00 +02001015 if (config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001016 return _PyStatus_ERR("initialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +02001017 }
1018
Victor Stinner331a6a52019-05-27 16:39:22 +02001019 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001020
Victor Stinner331a6a52019-05-27 16:39:22 +02001021 status = _PyRuntime_Initialize();
1022 if (_PyStatus_EXCEPTION(status)) {
1023 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001024 }
1025 _PyRuntimeState *runtime = &_PyRuntime;
1026
Victor Stinnerb45d2592019-06-20 00:05:23 +02001027 PyThreadState *tstate = NULL;
1028 status = pyinit_core(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001029 if (_PyStatus_EXCEPTION(status)) {
1030 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001031 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02001032 config = &tstate->interp->config;
Victor Stinnerbc8ac6b2017-11-30 18:03:55 +01001033
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001034 if (config->_init_main) {
Victor Stinnerb45d2592019-06-20 00:05:23 +02001035 status = pyinit_main(runtime, tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001036 if (_PyStatus_EXCEPTION(status)) {
1037 return status;
Victor Stinner484f20d2019-03-27 02:04:16 +01001038 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001039 }
Victor Stinner484f20d2019-03-27 02:04:16 +01001040
Victor Stinner331a6a52019-05-27 16:39:22 +02001041 return _PyStatus_OK();
Victor Stinner5ac27a52019-03-27 13:40:14 +01001042}
1043
1044
Eric Snow1abcf672017-05-23 21:46:51 -07001045void
Nick Coghland6009512014-11-20 21:39:37 +10001046Py_InitializeEx(int install_sigs)
1047{
Victor Stinner331a6a52019-05-27 16:39:22 +02001048 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001049
Victor Stinner331a6a52019-05-27 16:39:22 +02001050 status = _PyRuntime_Initialize();
1051 if (_PyStatus_EXCEPTION(status)) {
1052 Py_ExitStatusException(status);
Victor Stinner43125222019-04-24 18:23:53 +02001053 }
1054 _PyRuntimeState *runtime = &_PyRuntime;
1055
1056 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001057 /* bpo-33932: Calling Py_Initialize() twice does nothing. */
1058 return;
1059 }
1060
Victor Stinner331a6a52019-05-27 16:39:22 +02001061 PyConfig config;
1062 _PyConfig_InitCompatConfig(&config);
Victor Stinner1dc6e392018-07-25 02:49:17 +02001063 config.install_signal_handlers = install_sigs;
1064
Victor Stinner331a6a52019-05-27 16:39:22 +02001065 status = Py_InitializeFromConfig(&config);
1066 if (_PyStatus_EXCEPTION(status)) {
1067 Py_ExitStatusException(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001068 }
Nick Coghland6009512014-11-20 21:39:37 +10001069}
1070
1071void
1072Py_Initialize(void)
1073{
1074 Py_InitializeEx(1);
1075}
1076
1077
1078#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001079extern void _Py_dump_counts(FILE*);
Nick Coghland6009512014-11-20 21:39:37 +10001080#endif
1081
1082/* Flush stdout and stderr */
1083
1084static int
1085file_is_closed(PyObject *fobj)
1086{
1087 int r;
1088 PyObject *tmp = PyObject_GetAttrString(fobj, "closed");
1089 if (tmp == NULL) {
1090 PyErr_Clear();
1091 return 0;
1092 }
1093 r = PyObject_IsTrue(tmp);
1094 Py_DECREF(tmp);
1095 if (r < 0)
1096 PyErr_Clear();
1097 return r > 0;
1098}
1099
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001100static int
Nick Coghland6009512014-11-20 21:39:37 +10001101flush_std_files(void)
1102{
1103 PyObject *fout = _PySys_GetObjectId(&PyId_stdout);
1104 PyObject *ferr = _PySys_GetObjectId(&PyId_stderr);
1105 PyObject *tmp;
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001106 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001107
1108 if (fout != NULL && fout != Py_None && !file_is_closed(fout)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001109 tmp = _PyObject_CallMethodIdNoArgs(fout, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001110 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001111 PyErr_WriteUnraisable(fout);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001112 status = -1;
1113 }
Nick Coghland6009512014-11-20 21:39:37 +10001114 else
1115 Py_DECREF(tmp);
1116 }
1117
1118 if (ferr != NULL && ferr != Py_None && !file_is_closed(ferr)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001119 tmp = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001120 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001121 PyErr_Clear();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001122 status = -1;
1123 }
Nick Coghland6009512014-11-20 21:39:37 +10001124 else
1125 Py_DECREF(tmp);
1126 }
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001127
1128 return status;
Nick Coghland6009512014-11-20 21:39:37 +10001129}
1130
1131/* Undo the effect of Py_Initialize().
1132
1133 Beware: if multiple interpreter and/or thread states exist, these
1134 are not wiped out; only the current thread and interpreter state
1135 are deleted. But since everything else is deleted, those other
1136 interpreter and thread states should no longer be used.
1137
1138 (XXX We should do better, e.g. wipe out all interpreters and
1139 threads.)
1140
1141 Locking: as above.
1142
1143*/
1144
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001145int
1146Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001147{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001148 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001149
Victor Stinner8e91c242019-04-24 17:24:01 +02001150 _PyRuntimeState *runtime = &_PyRuntime;
1151 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001152 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001153 }
Nick Coghland6009512014-11-20 21:39:37 +10001154
Victor Stinnere225beb2019-06-03 18:14:24 +02001155 /* Get current thread state and interpreter pointer */
1156 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
1157 PyInterpreterState *interp = tstate->interp;
Victor Stinner8e91c242019-04-24 17:24:01 +02001158
Victor Stinnerb45d2592019-06-20 00:05:23 +02001159 // Wrap up existing "threading"-module-created, non-daemon threads.
1160 wait_for_thread_shutdown(tstate);
1161
1162 // Make any remaining pending calls.
1163 _Py_FinishPendingCalls(runtime);
1164
Nick Coghland6009512014-11-20 21:39:37 +10001165 /* The interpreter is still entirely intact at this point, and the
1166 * exit funcs may be relying on that. In particular, if some thread
1167 * or exit func is still waiting to do an import, the import machinery
1168 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001169 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001170 * Note that Threading.py uses an exit func to do a join on all the
1171 * threads created thru it, so this also protects pending imports in
1172 * the threads created via Threading.
1173 */
Nick Coghland6009512014-11-20 21:39:37 +10001174
Victor Stinnerb45d2592019-06-20 00:05:23 +02001175 call_py_exitfuncs(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001176
Victor Stinnerda273412017-12-15 01:46:02 +01001177 /* Copy the core config, PyInterpreterState_Delete() free
1178 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001179#ifdef Py_REF_DEBUG
Victor Stinner331a6a52019-05-27 16:39:22 +02001180 int show_ref_count = interp->config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001181#endif
1182#ifdef Py_TRACE_REFS
Victor Stinner331a6a52019-05-27 16:39:22 +02001183 int dump_refs = interp->config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001184#endif
1185#ifdef WITH_PYMALLOC
Victor Stinner331a6a52019-05-27 16:39:22 +02001186 int malloc_stats = interp->config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001187#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001188
Nick Coghland6009512014-11-20 21:39:37 +10001189 /* Remaining threads (e.g. daemon threads) will automatically exit
1190 after taking the GIL (in PyEval_RestoreThread()). */
Victor Stinner8e91c242019-04-24 17:24:01 +02001191 runtime->finalizing = tstate;
1192 runtime->initialized = 0;
1193 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001194
Victor Stinnere0deff32015-03-24 13:46:18 +01001195 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001196 if (flush_std_files() < 0) {
1197 status = -1;
1198 }
Nick Coghland6009512014-11-20 21:39:37 +10001199
1200 /* Disable signal handling */
1201 PyOS_FiniInterrupts();
1202
1203 /* Collect garbage. This may call finalizers; it's nice to call these
1204 * before all modules are destroyed.
1205 * XXX If a __del__ or weakref callback is triggered here, and tries to
1206 * XXX import a module, bad things can happen, because Python no
1207 * XXX longer believes it's initialized.
1208 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1209 * XXX is easy to provoke that way. I've also seen, e.g.,
1210 * XXX Exception exceptions.ImportError: 'No module named sha'
1211 * XXX in <function callback at 0x008F5718> ignored
1212 * XXX but I'm unclear on exactly how that one happens. In any case,
1213 * XXX I haven't seen a real-life report of either of these.
1214 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001215 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001216#ifdef COUNT_ALLOCS
1217 /* With COUNT_ALLOCS, it helps to run GC multiple times:
1218 each collection might release some types from the type
1219 list, so they become garbage. */
Łukasz Langafef7e942016-09-09 21:47:46 -07001220 while (_PyGC_CollectIfEnabled() > 0)
Nick Coghland6009512014-11-20 21:39:37 +10001221 /* nothing */;
1222#endif
Eric Snowdae02762017-09-14 00:35:58 -07001223
Steve Dowerb82e17e2019-05-23 08:45:22 -07001224 /* Clear all loghooks */
1225 /* We want minimal exposure of this function, so define the extern
1226 * here. The linker should discover the correct function without
1227 * exporting a symbol. */
1228 extern void _PySys_ClearAuditHooks(void);
1229 _PySys_ClearAuditHooks();
1230
Nick Coghland6009512014-11-20 21:39:37 +10001231 /* Destroy all modules */
Victor Stinner987a0dc2019-06-19 10:36:10 +02001232 _PyImport_Cleanup(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001233
Inada Naoki91234a12019-06-03 21:30:58 +09001234 /* Print debug stats if any */
1235 _PyEval_Fini();
1236
Victor Stinnere0deff32015-03-24 13:46:18 +01001237 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001238 if (flush_std_files() < 0) {
1239 status = -1;
1240 }
Nick Coghland6009512014-11-20 21:39:37 +10001241
1242 /* Collect final garbage. This disposes of cycles created by
1243 * class definitions, for example.
1244 * XXX This is disabled because it caused too many problems. If
1245 * XXX a __del__ or weakref callback triggers here, Python code has
1246 * XXX a hard time running, because even the sys module has been
1247 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1248 * XXX One symptom is a sequence of information-free messages
1249 * XXX coming from threads (if a __del__ or callback is invoked,
1250 * XXX other threads can execute too, and any exception they encounter
1251 * XXX triggers a comedy of errors as subsystem after subsystem
1252 * XXX fails to find what it *expects* to find in sys to help report
1253 * XXX the exception and consequent unexpected failures). I've also
1254 * XXX seen segfaults then, after adding print statements to the
1255 * XXX Python code getting called.
1256 */
1257#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001258 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001259#endif
1260
1261 /* Disable tracemalloc after all Python objects have been destroyed,
1262 so it is possible to use tracemalloc in objects destructor. */
1263 _PyTraceMalloc_Fini();
1264
1265 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1266 _PyImport_Fini();
1267
1268 /* Cleanup typeobject.c's internal caches. */
1269 _PyType_Fini();
1270
1271 /* unload faulthandler module */
1272 _PyFaulthandler_Fini();
1273
1274 /* Debugging stuff */
1275#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001276 _Py_dump_counts(stderr);
Nick Coghland6009512014-11-20 21:39:37 +10001277#endif
1278 /* dump hash stats */
1279 _PyHash_Fini();
1280
Eric Snowdae02762017-09-14 00:35:58 -07001281#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001282 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001283 _PyDebug_PrintTotalRefs();
1284 }
Eric Snowdae02762017-09-14 00:35:58 -07001285#endif
Nick Coghland6009512014-11-20 21:39:37 +10001286
1287#ifdef Py_TRACE_REFS
1288 /* Display all objects still alive -- this can invoke arbitrary
1289 * __repr__ overrides, so requires a mostly-intact interpreter.
1290 * Alas, a lot of stuff may still be alive now that will be cleaned
1291 * up later.
1292 */
Victor Stinnerda273412017-12-15 01:46:02 +01001293 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001294 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001295 }
Nick Coghland6009512014-11-20 21:39:37 +10001296#endif /* Py_TRACE_REFS */
1297
1298 /* Clear interpreter state and all thread states. */
1299 PyInterpreterState_Clear(interp);
1300
1301 /* Now we decref the exception classes. After this point nothing
1302 can raise an exception. That's okay, because each Fini() method
1303 below has been checked to make sure no exceptions are ever
1304 raised.
1305 */
1306
1307 _PyExc_Fini();
1308
1309 /* Sundry finalizers */
Victor Stinnerbed48172019-08-27 00:12:32 +02001310 _PyMethod_Fini();
1311 _PyFrame_Fini();
1312 _PyCFunction_Fini();
1313 _PyTuple_Fini();
1314 _PyList_Fini();
1315 _PySet_Fini();
1316 _PyBytes_Fini();
1317 _PyLong_Fini();
1318 _PyFloat_Fini();
1319 _PyDict_Fini();
1320 _PySlice_Fini();
Victor Stinner8e91c242019-04-24 17:24:01 +02001321 _PyGC_Fini(runtime);
Eric Snow86ea5812019-05-10 13:29:55 -04001322 _PyWarnings_Fini(interp);
Eric Snow6b4be192017-05-22 21:36:03 -07001323 _Py_HashRandomization_Fini();
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001324 _PyArg_Fini();
Victor Stinnerbed48172019-08-27 00:12:32 +02001325 _PyAsyncGen_Fini();
Yury Selivanovf23746a2018-01-22 19:11:18 -05001326 _PyContext_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001327
1328 /* Cleanup Unicode implementation */
1329 _PyUnicode_Fini();
1330
Victor Stinnerb2457ef2018-08-29 13:25:36 +02001331 _Py_ClearFileSystemEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10001332
1333 /* XXX Still allocated:
1334 - various static ad-hoc pointers to interned strings
1335 - int and float free list blocks
1336 - whatever various modules and libraries allocate
1337 */
1338
1339 PyGrammar_RemoveAccelerators(&_PyParser_Grammar);
1340
1341 /* Cleanup auto-thread-state */
Victor Stinner8e91c242019-04-24 17:24:01 +02001342 _PyGILState_Fini(runtime);
Nick Coghland6009512014-11-20 21:39:37 +10001343
1344 /* Delete current thread. After this, many C API calls become crashy. */
1345 PyThreadState_Swap(NULL);
Victor Stinner8a1be612016-03-14 22:07:55 +01001346
Nick Coghland6009512014-11-20 21:39:37 +10001347 PyInterpreterState_Delete(interp);
1348
1349#ifdef Py_TRACE_REFS
1350 /* Display addresses (& refcnts) of all objects still alive.
1351 * An address can be used to find the repr of the object, printed
1352 * above by _Py_PrintReferences.
1353 */
Victor Stinnerda273412017-12-15 01:46:02 +01001354 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001355 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001356 }
Nick Coghland6009512014-11-20 21:39:37 +10001357#endif /* Py_TRACE_REFS */
Victor Stinner34be8072016-03-14 12:04:26 +01001358#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001359 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001360 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be8072016-03-14 12:04:26 +01001361 }
Nick Coghland6009512014-11-20 21:39:37 +10001362#endif
1363
Victor Stinner8e91c242019-04-24 17:24:01 +02001364 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001365
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001366 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001367 return status;
1368}
1369
1370void
1371Py_Finalize(void)
1372{
1373 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001374}
1375
1376/* Create and initialize a new interpreter and thread, and return the
1377 new thread. This requires that Py_Initialize() has been called
1378 first.
1379
1380 Unsuccessful initialization yields a NULL pointer. Note that *no*
1381 exception information is available even in this case -- the
1382 exception information is held in the thread, and there is no
1383 thread.
1384
1385 Locking: as above.
1386
1387*/
1388
Victor Stinner331a6a52019-05-27 16:39:22 +02001389static PyStatus
Victor Stinnera7368ac2017-11-15 18:11:45 -08001390new_interpreter(PyThreadState **tstate_p)
Nick Coghland6009512014-11-20 21:39:37 +10001391{
Victor Stinner331a6a52019-05-27 16:39:22 +02001392 PyStatus status;
Nick Coghland6009512014-11-20 21:39:37 +10001393
Victor Stinner331a6a52019-05-27 16:39:22 +02001394 status = _PyRuntime_Initialize();
1395 if (_PyStatus_EXCEPTION(status)) {
1396 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001397 }
1398 _PyRuntimeState *runtime = &_PyRuntime;
1399
1400 if (!runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001401 return _PyStatus_ERR("Py_Initialize must be called first");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001402 }
Nick Coghland6009512014-11-20 21:39:37 +10001403
Victor Stinner8a1be612016-03-14 22:07:55 +01001404 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1405 interpreters: disable PyGILState_Check(). */
1406 _PyGILState_check_enabled = 0;
1407
Victor Stinner43125222019-04-24 18:23:53 +02001408 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001409 if (interp == NULL) {
1410 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001411 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001412 }
Nick Coghland6009512014-11-20 21:39:37 +10001413
Victor Stinner43125222019-04-24 18:23:53 +02001414 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001415 if (tstate == NULL) {
1416 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001417 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001418 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001419 }
1420
Victor Stinner43125222019-04-24 18:23:53 +02001421 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001422
Eric Snow1abcf672017-05-23 21:46:51 -07001423 /* Copy the current interpreter config into the new interpreter */
Victor Stinner331a6a52019-05-27 16:39:22 +02001424 PyConfig *config;
Eric Snow1abcf672017-05-23 21:46:51 -07001425 if (save_tstate != NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001426 config = &save_tstate->interp->config;
Eric Snow1abcf672017-05-23 21:46:51 -07001427 } else {
1428 /* No current thread state, copy from the main interpreter */
1429 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinner331a6a52019-05-27 16:39:22 +02001430 config = &main_interp->config;
Victor Stinnerda273412017-12-15 01:46:02 +01001431 }
1432
Victor Stinner331a6a52019-05-27 16:39:22 +02001433 status = _PyConfig_Copy(&interp->config, config);
1434 if (_PyStatus_EXCEPTION(status)) {
1435 return status;
Victor Stinnerda273412017-12-15 01:46:02 +01001436 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001437 config = &interp->config;
Eric Snow1abcf672017-05-23 21:46:51 -07001438
Victor Stinner331a6a52019-05-27 16:39:22 +02001439 status = _PyExc_Init();
1440 if (_PyStatus_EXCEPTION(status)) {
1441 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001442 }
1443
Victor Stinner331a6a52019-05-27 16:39:22 +02001444 status = _PyErr_Init();
1445 if (_PyStatus_EXCEPTION(status)) {
1446 return status;
Victor Stinneref9d9b62019-05-22 11:28:22 +02001447 }
1448
1449
Nick Coghland6009512014-11-20 21:39:37 +10001450 /* XXX The following is lax in error checking */
Eric Snowd393c1b2017-09-14 12:18:12 -06001451 PyObject *modules = PyDict_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001452 if (modules == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001453 return _PyStatus_ERR("can't make modules dictionary");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001454 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001455 interp->modules = modules;
Nick Coghland6009512014-11-20 21:39:37 +10001456
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001457 PyObject *sysmod = _PyImport_FindBuiltin(tstate, "sys");
Eric Snowd393c1b2017-09-14 12:18:12 -06001458 if (sysmod != NULL) {
1459 interp->sysdict = PyModule_GetDict(sysmod);
Victor Stinner43125222019-04-24 18:23:53 +02001460 if (interp->sysdict == NULL) {
Eric Snowd393c1b2017-09-14 12:18:12 -06001461 goto handle_error;
Victor Stinner43125222019-04-24 18:23:53 +02001462 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001463 Py_INCREF(interp->sysdict);
1464 PyDict_SetItemString(interp->sysdict, "modules", modules);
Victor Stinner838f2642019-06-13 22:41:23 +02001465 if (_PySys_InitMain(runtime, tstate) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001466 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerab672812019-01-23 15:04:40 +01001467 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001468 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02001469 else if (_PyErr_Occurred(tstate)) {
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001470 goto handle_error;
1471 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001472
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001473 PyObject *bimod = _PyImport_FindBuiltin(tstate, "builtins");
Nick Coghland6009512014-11-20 21:39:37 +10001474 if (bimod != NULL) {
1475 interp->builtins = PyModule_GetDict(bimod);
1476 if (interp->builtins == NULL)
1477 goto handle_error;
1478 Py_INCREF(interp->builtins);
1479 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02001480 else if (_PyErr_Occurred(tstate)) {
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001481 goto handle_error;
1482 }
Nick Coghland6009512014-11-20 21:39:37 +10001483
Nick Coghland6009512014-11-20 21:39:37 +10001484 if (bimod != NULL && sysmod != NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001485 status = _PyBuiltins_AddExceptions(bimod);
1486 if (_PyStatus_EXCEPTION(status)) {
1487 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001488 }
Nick Coghland6009512014-11-20 21:39:37 +10001489
Victor Stinner331a6a52019-05-27 16:39:22 +02001490 status = _PySys_SetPreliminaryStderr(interp->sysdict);
1491 if (_PyStatus_EXCEPTION(status)) {
1492 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001493 }
Nick Coghland6009512014-11-20 21:39:37 +10001494
Victor Stinnerb45d2592019-06-20 00:05:23 +02001495 status = _PyImportHooks_Init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001496 if (_PyStatus_EXCEPTION(status)) {
1497 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001498 }
Nick Coghland6009512014-11-20 21:39:37 +10001499
Victor Stinnerb45d2592019-06-20 00:05:23 +02001500 status = init_importlib(tstate, sysmod);
Victor Stinner331a6a52019-05-27 16:39:22 +02001501 if (_PyStatus_EXCEPTION(status)) {
1502 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001503 }
Nick Coghland6009512014-11-20 21:39:37 +10001504
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001505 status = init_importlib_external(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001506 if (_PyStatus_EXCEPTION(status)) {
1507 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001508 }
Nick Coghland6009512014-11-20 21:39:37 +10001509
Victor Stinnerb45d2592019-06-20 00:05:23 +02001510 status = _PyUnicode_InitEncodings(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001511 if (_PyStatus_EXCEPTION(status)) {
1512 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001513 }
1514
Victor Stinnerb45d2592019-06-20 00:05:23 +02001515 status = init_sys_streams(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001516 if (_PyStatus_EXCEPTION(status)) {
1517 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001518 }
1519
Victor Stinner331a6a52019-05-27 16:39:22 +02001520 status = add_main_module(interp);
1521 if (_PyStatus_EXCEPTION(status)) {
1522 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001523 }
1524
Victor Stinner331a6a52019-05-27 16:39:22 +02001525 if (config->site_import) {
Victor Stinnerb45d2592019-06-20 00:05:23 +02001526 status = init_import_site();
Victor Stinner331a6a52019-05-27 16:39:22 +02001527 if (_PyStatus_EXCEPTION(status)) {
1528 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001529 }
1530 }
Nick Coghland6009512014-11-20 21:39:37 +10001531 }
1532
Victor Stinnerb45d2592019-06-20 00:05:23 +02001533 if (_PyErr_Occurred(tstate)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001534 goto handle_error;
1535 }
Nick Coghland6009512014-11-20 21:39:37 +10001536
Victor Stinnera7368ac2017-11-15 18:11:45 -08001537 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +02001538 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001539
Nick Coghland6009512014-11-20 21:39:37 +10001540handle_error:
1541 /* Oops, it didn't work. Undo it all. */
1542
1543 PyErr_PrintEx(0);
1544 PyThreadState_Clear(tstate);
1545 PyThreadState_Swap(save_tstate);
1546 PyThreadState_Delete(tstate);
1547 PyInterpreterState_Delete(interp);
1548
Victor Stinnera7368ac2017-11-15 18:11:45 -08001549 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001550 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001551}
1552
1553PyThreadState *
1554Py_NewInterpreter(void)
1555{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001556 PyThreadState *tstate = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001557 PyStatus status = new_interpreter(&tstate);
1558 if (_PyStatus_EXCEPTION(status)) {
1559 Py_ExitStatusException(status);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001560 }
1561 return tstate;
1562
Nick Coghland6009512014-11-20 21:39:37 +10001563}
1564
1565/* Delete an interpreter and its last thread. This requires that the
1566 given thread state is current, that the thread has no remaining
1567 frames, and that it is its interpreter's only remaining thread.
1568 It is a fatal error to violate these constraints.
1569
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001570 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001571 everything, regardless.)
1572
1573 Locking: as above.
1574
1575*/
1576
1577void
1578Py_EndInterpreter(PyThreadState *tstate)
1579{
1580 PyInterpreterState *interp = tstate->interp;
1581
Victor Stinnerb45d2592019-06-20 00:05:23 +02001582 if (tstate != _PyThreadState_GET()) {
Nick Coghland6009512014-11-20 21:39:37 +10001583 Py_FatalError("Py_EndInterpreter: thread is not current");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001584 }
1585 if (tstate->frame != NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001586 Py_FatalError("Py_EndInterpreter: thread still has a frame");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001587 }
Eric Snow5be45a62019-03-08 22:47:07 -07001588 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001589
Eric Snow842a2f02019-03-15 15:47:51 -06001590 // Wrap up existing "threading"-module-created, non-daemon threads.
Victor Stinnerb45d2592019-06-20 00:05:23 +02001591 wait_for_thread_shutdown(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001592
Victor Stinnerb45d2592019-06-20 00:05:23 +02001593 call_py_exitfuncs(tstate);
Marcel Plch776407f2017-12-20 11:17:58 +01001594
Victor Stinnerb45d2592019-06-20 00:05:23 +02001595 if (tstate != interp->tstate_head || tstate->next != NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001596 Py_FatalError("Py_EndInterpreter: not the last thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001597 }
Nick Coghland6009512014-11-20 21:39:37 +10001598
Victor Stinner987a0dc2019-06-19 10:36:10 +02001599 _PyImport_Cleanup(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001600 PyInterpreterState_Clear(interp);
1601 PyThreadState_Swap(NULL);
1602 PyInterpreterState_Delete(interp);
1603}
1604
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001605/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001606
Victor Stinner331a6a52019-05-27 16:39:22 +02001607static PyStatus
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001608add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001609{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001610 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001611 m = PyImport_AddModule("__main__");
1612 if (m == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +02001613 return _PyStatus_ERR("can't create __main__ module");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001614
Nick Coghland6009512014-11-20 21:39:37 +10001615 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001616 ann_dict = PyDict_New();
1617 if ((ann_dict == NULL) ||
1618 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001619 return _PyStatus_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001620 }
1621 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001622
Nick Coghland6009512014-11-20 21:39:37 +10001623 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1624 PyObject *bimod = PyImport_ImportModule("builtins");
1625 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001626 return _PyStatus_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001627 }
1628 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001629 return _PyStatus_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001630 }
1631 Py_DECREF(bimod);
1632 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001633
Nick Coghland6009512014-11-20 21:39:37 +10001634 /* Main is a little special - imp.is_builtin("__main__") will return
1635 * False, but BuiltinImporter is still the most appropriate initial
1636 * setting for its __loader__ attribute. A more suitable value will
1637 * be set if __main__ gets further initialized later in the startup
1638 * process.
1639 */
1640 loader = PyDict_GetItemString(d, "__loader__");
1641 if (loader == NULL || loader == Py_None) {
1642 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1643 "BuiltinImporter");
1644 if (loader == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001645 return _PyStatus_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001646 }
1647 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001648 return _PyStatus_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001649 }
1650 Py_DECREF(loader);
1651 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001652 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001653}
1654
Nick Coghland6009512014-11-20 21:39:37 +10001655/* Import the site module (not into __main__ though) */
1656
Victor Stinner331a6a52019-05-27 16:39:22 +02001657static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001658init_import_site(void)
Nick Coghland6009512014-11-20 21:39:37 +10001659{
1660 PyObject *m;
1661 m = PyImport_ImportModule("site");
1662 if (m == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001663 return _PyStatus_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001664 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001665 Py_DECREF(m);
Victor Stinner331a6a52019-05-27 16:39:22 +02001666 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001667}
1668
Victor Stinner874dbe82015-09-04 17:29:57 +02001669/* Check if a file descriptor is valid or not.
1670 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1671static int
1672is_valid_fd(int fd)
1673{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001674/* dup() is faster than fstat(): fstat() can require input/output operations,
1675 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1676 startup. Problem: dup() doesn't check if the file descriptor is valid on
1677 some platforms.
1678
1679 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1680 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1681 EBADF. FreeBSD has similar issue (bpo-32849).
1682
1683 Only use dup() on platforms where dup() is enough to detect invalid FD in
1684 corner cases: on Linux and Windows (bpo-32849). */
1685#if defined(__linux__) || defined(MS_WINDOWS)
1686 if (fd < 0) {
1687 return 0;
1688 }
1689 int fd2;
1690
1691 _Py_BEGIN_SUPPRESS_IPH
1692 fd2 = dup(fd);
1693 if (fd2 >= 0) {
1694 close(fd2);
1695 }
1696 _Py_END_SUPPRESS_IPH
1697
1698 return (fd2 >= 0);
1699#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001700 struct stat st;
1701 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001702#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001703}
1704
1705/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001706static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02001707create_stdio(const PyConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001708 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001709 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001710{
1711 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1712 const char* mode;
1713 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001714 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001715 int buffering, isatty;
1716 _Py_IDENTIFIER(open);
1717 _Py_IDENTIFIER(isatty);
1718 _Py_IDENTIFIER(TextIOWrapper);
1719 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001720 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001721
Victor Stinner874dbe82015-09-04 17:29:57 +02001722 if (!is_valid_fd(fd))
1723 Py_RETURN_NONE;
1724
Nick Coghland6009512014-11-20 21:39:37 +10001725 /* stdin is always opened in buffered mode, first because it shouldn't
1726 make a difference in common use cases, second because TextIOWrapper
1727 depends on the presence of a read1() method which only exists on
1728 buffered streams.
1729 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001730 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001731 buffering = 0;
1732 else
1733 buffering = -1;
1734 if (write_mode)
1735 mode = "wb";
1736 else
1737 mode = "rb";
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001738 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOO",
Nick Coghland6009512014-11-20 21:39:37 +10001739 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001740 Py_None, Py_None, /* encoding, errors */
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001741 Py_None, Py_False); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001742 if (buf == NULL)
1743 goto error;
1744
1745 if (buffering) {
1746 _Py_IDENTIFIER(raw);
1747 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1748 if (raw == NULL)
1749 goto error;
1750 }
1751 else {
1752 raw = buf;
1753 Py_INCREF(raw);
1754 }
1755
Steve Dower39294992016-08-30 21:22:36 -07001756#ifdef MS_WINDOWS
1757 /* Windows console IO is always UTF-8 encoded */
1758 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001759 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001760#endif
1761
Nick Coghland6009512014-11-20 21:39:37 +10001762 text = PyUnicode_FromString(name);
1763 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1764 goto error;
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001765 res = _PyObject_CallMethodIdNoArgs(raw, &PyId_isatty);
Nick Coghland6009512014-11-20 21:39:37 +10001766 if (res == NULL)
1767 goto error;
1768 isatty = PyObject_IsTrue(res);
1769 Py_DECREF(res);
1770 if (isatty == -1)
1771 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001772 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001773 write_through = Py_True;
1774 else
1775 write_through = Py_False;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001776 if (isatty && buffered_stdio)
Nick Coghland6009512014-11-20 21:39:37 +10001777 line_buffering = Py_True;
1778 else
1779 line_buffering = Py_False;
1780
1781 Py_CLEAR(raw);
1782 Py_CLEAR(text);
1783
1784#ifdef MS_WINDOWS
1785 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1786 newlines to "\n".
1787 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1788 newline = NULL;
1789#else
1790 /* sys.stdin: split lines at "\n".
1791 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1792 newline = "\n";
1793#endif
1794
Victor Stinner709d23d2019-05-02 14:56:30 -04001795 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1796 if (encoding_str == NULL) {
1797 Py_CLEAR(buf);
1798 goto error;
1799 }
1800
1801 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1802 if (errors_str == NULL) {
1803 Py_CLEAR(buf);
1804 Py_CLEAR(encoding_str);
1805 goto error;
1806 }
1807
1808 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1809 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001810 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001811 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001812 Py_CLEAR(encoding_str);
1813 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001814 if (stream == NULL)
1815 goto error;
1816
1817 if (write_mode)
1818 mode = "w";
1819 else
1820 mode = "r";
1821 text = PyUnicode_FromString(mode);
1822 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1823 goto error;
1824 Py_CLEAR(text);
1825 return stream;
1826
1827error:
1828 Py_XDECREF(buf);
1829 Py_XDECREF(stream);
1830 Py_XDECREF(text);
1831 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001832
Victor Stinner874dbe82015-09-04 17:29:57 +02001833 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1834 /* Issue #24891: the file descriptor was closed after the first
1835 is_valid_fd() check was called. Ignore the OSError and set the
1836 stream to None. */
1837 PyErr_Clear();
1838 Py_RETURN_NONE;
1839 }
1840 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001841}
1842
1843/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinner331a6a52019-05-27 16:39:22 +02001844static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001845init_sys_streams(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10001846{
1847 PyObject *iomod = NULL, *wrapper;
1848 PyObject *bimod = NULL;
1849 PyObject *m;
1850 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001851 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001852 PyObject * encoding_attr;
Victor Stinner331a6a52019-05-27 16:39:22 +02001853 PyStatus res = _PyStatus_OK();
Victor Stinnerb45d2592019-06-20 00:05:23 +02001854 const PyConfig *config = &tstate->interp->config;
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001855
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001856 /* Check that stdin is not a directory
1857 Using shell redirection, you can redirect stdin to a directory,
1858 crashing the Python interpreter. Catch this common mistake here
1859 and output a useful error message. Note that under MS Windows,
1860 the shell already prevents that. */
1861#ifndef MS_WINDOWS
1862 struct _Py_stat_struct sb;
1863 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1864 S_ISDIR(sb.st_mode)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001865 return _PyStatus_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001866 }
1867#endif
1868
Nick Coghland6009512014-11-20 21:39:37 +10001869 /* Hack to avoid a nasty recursion issue when Python is invoked
1870 in verbose mode: pre-import the Latin-1 and UTF-8 codecs */
1871 if ((m = PyImport_ImportModule("encodings.utf_8")) == NULL) {
1872 goto error;
1873 }
1874 Py_DECREF(m);
1875
1876 if (!(m = PyImport_ImportModule("encodings.latin_1"))) {
1877 goto error;
1878 }
1879 Py_DECREF(m);
1880
1881 if (!(bimod = PyImport_ImportModule("builtins"))) {
1882 goto error;
1883 }
1884
1885 if (!(iomod = PyImport_ImportModule("io"))) {
1886 goto error;
1887 }
1888 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1889 goto error;
1890 }
1891
1892 /* Set builtins.open */
1893 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1894 Py_DECREF(wrapper);
1895 goto error;
1896 }
1897 Py_DECREF(wrapper);
1898
Nick Coghland6009512014-11-20 21:39:37 +10001899 /* Set sys.stdin */
1900 fd = fileno(stdin);
1901 /* Under some conditions stdin, stdout and stderr may not be connected
1902 * and fileno() may point to an invalid file descriptor. For example
1903 * GUI apps don't have valid standard streams by default.
1904 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001905 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001906 config->stdio_encoding,
1907 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001908 if (std == NULL)
1909 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001910 PySys_SetObject("__stdin__", std);
1911 _PySys_SetObjectId(&PyId_stdin, std);
1912 Py_DECREF(std);
1913
1914 /* Set sys.stdout */
1915 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001916 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001917 config->stdio_encoding,
1918 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001919 if (std == NULL)
1920 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001921 PySys_SetObject("__stdout__", std);
1922 _PySys_SetObjectId(&PyId_stdout, std);
1923 Py_DECREF(std);
1924
1925#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
1926 /* Set sys.stderr, replaces the preliminary stderr */
1927 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001928 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001929 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04001930 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02001931 if (std == NULL)
1932 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001933
1934 /* Same as hack above, pre-import stderr's codec to avoid recursion
1935 when import.c tries to write to stderr in verbose mode. */
1936 encoding_attr = PyObject_GetAttrString(std, "encoding");
1937 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001938 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10001939 if (std_encoding != NULL) {
1940 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
1941 Py_XDECREF(codec_info);
1942 }
1943 Py_DECREF(encoding_attr);
1944 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02001945 _PyErr_Clear(tstate); /* Not a fatal error if codec isn't available */
Nick Coghland6009512014-11-20 21:39:37 +10001946
1947 if (PySys_SetObject("__stderr__", std) < 0) {
1948 Py_DECREF(std);
1949 goto error;
1950 }
1951 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
1952 Py_DECREF(std);
1953 goto error;
1954 }
1955 Py_DECREF(std);
1956#endif
1957
Victor Stinnera7368ac2017-11-15 18:11:45 -08001958 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10001959
Victor Stinnera7368ac2017-11-15 18:11:45 -08001960error:
Victor Stinner331a6a52019-05-27 16:39:22 +02001961 res = _PyStatus_ERR("can't initialize sys standard streams");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001962
1963done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02001964 _Py_ClearStandardStreamEncoding();
Victor Stinner31e99082017-12-20 23:41:38 +01001965
Nick Coghland6009512014-11-20 21:39:37 +10001966 Py_XDECREF(bimod);
1967 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001968 return res;
Nick Coghland6009512014-11-20 21:39:37 +10001969}
1970
1971
Victor Stinner10dc4842015-03-24 12:01:30 +01001972static void
Victor Stinner791da1c2016-03-14 16:53:12 +01001973_Py_FatalError_DumpTracebacks(int fd)
Victor Stinner10dc4842015-03-24 12:01:30 +01001974{
Victor Stinner10dc4842015-03-24 12:01:30 +01001975 fputc('\n', stderr);
1976 fflush(stderr);
1977
1978 /* display the current Python stack */
Victor Stinner861d9ab2016-03-16 22:45:24 +01001979 _Py_DumpTracebackThreads(fd, NULL, NULL);
Victor Stinner10dc4842015-03-24 12:01:30 +01001980}
Victor Stinner791da1c2016-03-14 16:53:12 +01001981
1982/* Print the current exception (if an exception is set) with its traceback,
1983 or display the current Python stack.
1984
1985 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
1986 called on catastrophic cases.
1987
1988 Return 1 if the traceback was displayed, 0 otherwise. */
1989
1990static int
1991_Py_FatalError_PrintExc(int fd)
1992{
Victor Stinnerb45d2592019-06-20 00:05:23 +02001993 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner791da1c2016-03-14 16:53:12 +01001994 PyObject *ferr, *res;
1995 PyObject *exception, *v, *tb;
1996 int has_tb;
1997
Victor Stinnerb45d2592019-06-20 00:05:23 +02001998 _PyErr_Fetch(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01001999 if (exception == NULL) {
2000 /* No current exception */
2001 return 0;
2002 }
2003
2004 ferr = _PySys_GetObjectId(&PyId_stderr);
2005 if (ferr == NULL || ferr == Py_None) {
2006 /* sys.stderr is not set yet or set to None,
2007 no need to try to display the exception */
2008 return 0;
2009 }
2010
Victor Stinnerb45d2592019-06-20 00:05:23 +02002011 _PyErr_NormalizeException(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002012 if (tb == NULL) {
2013 tb = Py_None;
2014 Py_INCREF(tb);
2015 }
2016 PyException_SetTraceback(v, tb);
2017 if (exception == NULL) {
2018 /* PyErr_NormalizeException() failed */
2019 return 0;
2020 }
2021
2022 has_tb = (tb != Py_None);
2023 PyErr_Display(exception, v, tb);
2024 Py_XDECREF(exception);
2025 Py_XDECREF(v);
2026 Py_XDECREF(tb);
2027
2028 /* sys.stderr may be buffered: call sys.stderr.flush() */
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002029 res = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002030 if (res == NULL) {
2031 _PyErr_Clear(tstate);
2032 }
2033 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002034 Py_DECREF(res);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002035 }
Victor Stinner791da1c2016-03-14 16:53:12 +01002036
2037 return has_tb;
2038}
2039
Nick Coghland6009512014-11-20 21:39:37 +10002040/* Print fatal error message and abort */
2041
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002042#ifdef MS_WINDOWS
2043static void
2044fatal_output_debug(const char *msg)
2045{
2046 /* buffer of 256 bytes allocated on the stack */
2047 WCHAR buffer[256 / sizeof(WCHAR)];
2048 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2049 size_t msglen;
2050
2051 OutputDebugStringW(L"Fatal Python error: ");
2052
2053 msglen = strlen(msg);
2054 while (msglen) {
2055 size_t i;
2056
2057 if (buflen > msglen) {
2058 buflen = msglen;
2059 }
2060
2061 /* Convert the message to wchar_t. This uses a simple one-to-one
2062 conversion, assuming that the this error message actually uses
2063 ASCII only. If this ceases to be true, we will have to convert. */
2064 for (i=0; i < buflen; ++i) {
2065 buffer[i] = msg[i];
2066 }
2067 buffer[i] = L'\0';
2068 OutputDebugStringW(buffer);
2069
2070 msg += buflen;
2071 msglen -= buflen;
2072 }
2073 OutputDebugStringW(L"\n");
2074}
2075#endif
2076
Benjamin Petersoncef88b92017-11-25 13:02:55 -08002077static void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002078fatal_error(const char *prefix, const char *msg, int status)
Nick Coghland6009512014-11-20 21:39:37 +10002079{
2080 const int fd = fileno(stderr);
Victor Stinner53345a42015-03-25 01:55:14 +01002081 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002082
2083 if (reentrant) {
2084 /* Py_FatalError() caused a second fatal error.
2085 Example: flush_std_files() raises a recursion error. */
2086 goto exit;
2087 }
2088 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002089
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002090 fprintf(stderr, "Fatal Python error: ");
2091 if (prefix) {
2092 fputs(prefix, stderr);
2093 fputs(": ", stderr);
2094 }
2095 if (msg) {
2096 fputs(msg, stderr);
2097 }
2098 else {
2099 fprintf(stderr, "<message not set>");
2100 }
2101 fputs("\n", stderr);
Nick Coghland6009512014-11-20 21:39:37 +10002102 fflush(stderr); /* it helps in Windows debug build */
Victor Stinner10dc4842015-03-24 12:01:30 +01002103
Victor Stinner3a228ab2018-11-01 00:26:41 +01002104 /* Check if the current thread has a Python thread state
2105 and holds the GIL */
2106 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2107 if (tss_tstate != NULL) {
Victor Stinner50b48572018-11-01 01:51:40 +01002108 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner3a228ab2018-11-01 00:26:41 +01002109 if (tss_tstate != tstate) {
2110 /* The Python thread does not hold the GIL */
2111 tss_tstate = NULL;
2112 }
2113 }
2114 else {
2115 /* Py_FatalError() has been called from a C thread
2116 which has no Python thread state. */
2117 }
2118 int has_tstate_and_gil = (tss_tstate != NULL);
2119
2120 if (has_tstate_and_gil) {
2121 /* If an exception is set, print the exception with its traceback */
2122 if (!_Py_FatalError_PrintExc(fd)) {
2123 /* No exception is set, or an exception is set without traceback */
2124 _Py_FatalError_DumpTracebacks(fd);
2125 }
2126 }
2127 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002128 _Py_FatalError_DumpTracebacks(fd);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002129 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002130
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002131 /* The main purpose of faulthandler is to display the traceback.
2132 This function already did its best to display a traceback.
2133 Disable faulthandler to prevent writing a second traceback
2134 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002135 _PyFaulthandler_Fini();
2136
Victor Stinner791da1c2016-03-14 16:53:12 +01002137 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002138 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002139 /* Flush sys.stdout and sys.stderr */
2140 flush_std_files();
2141 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002142
Nick Coghland6009512014-11-20 21:39:37 +10002143#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002144 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002145#endif /* MS_WINDOWS */
2146
2147exit:
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002148 if (status < 0) {
Victor Stinner53345a42015-03-25 01:55:14 +01002149#if defined(MS_WINDOWS) && defined(_DEBUG)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002150 DebugBreak();
Nick Coghland6009512014-11-20 21:39:37 +10002151#endif
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002152 abort();
2153 }
2154 else {
2155 exit(status);
2156 }
2157}
2158
Victor Stinner19760862017-12-20 01:41:59 +01002159void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002160Py_FatalError(const char *msg)
2161{
2162 fatal_error(NULL, msg, -1);
2163}
2164
Victor Stinner19760862017-12-20 01:41:59 +01002165void _Py_NO_RETURN
Victor Stinner331a6a52019-05-27 16:39:22 +02002166Py_ExitStatusException(PyStatus status)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002167{
Victor Stinner331a6a52019-05-27 16:39:22 +02002168 if (_PyStatus_IS_EXIT(status)) {
2169 exit(status.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002170 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002171 else if (_PyStatus_IS_ERROR(status)) {
2172 fatal_error(status.func, status.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002173 }
2174 else {
Victor Stinner331a6a52019-05-27 16:39:22 +02002175 Py_FatalError("Py_ExitStatusException() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002176 }
Nick Coghland6009512014-11-20 21:39:37 +10002177}
2178
2179/* Clean up and exit */
2180
Victor Stinnerd7292b52016-06-17 12:29:00 +02002181# include "pythread.h"
Nick Coghland6009512014-11-20 21:39:37 +10002182
Nick Coghland6009512014-11-20 21:39:37 +10002183/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002184void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002185{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002186 PyInterpreterState *is = _PyInterpreterState_GET_UNSAFE();
Marcel Plch776407f2017-12-20 11:17:58 +01002187
Antoine Pitroufc5db952017-12-13 02:29:07 +01002188 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002189 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2190
2191 is->pyexitfunc = func;
2192 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002193}
2194
2195static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002196call_py_exitfuncs(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002197{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002198 PyInterpreterState *interp = tstate->interp;
2199 if (interp->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002200 return;
2201
Victor Stinnerb45d2592019-06-20 00:05:23 +02002202 (*interp->pyexitfunc)(interp->pyexitmodule);
2203 _PyErr_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10002204}
2205
2206/* Wait until threading._shutdown completes, provided
2207 the threading module was imported in the first place.
2208 The shutdown routine will wait until all non-daemon
2209 "threading" threads have completed. */
2210static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002211wait_for_thread_shutdown(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002212{
Nick Coghland6009512014-11-20 21:39:37 +10002213 _Py_IDENTIFIER(_shutdown);
2214 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002215 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002216 if (threading == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +02002217 if (_PyErr_Occurred(tstate)) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002218 PyErr_WriteUnraisable(NULL);
2219 }
2220 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002221 return;
2222 }
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002223 result = _PyObject_CallMethodIdNoArgs(threading, &PyId__shutdown);
Nick Coghland6009512014-11-20 21:39:37 +10002224 if (result == NULL) {
2225 PyErr_WriteUnraisable(threading);
2226 }
2227 else {
2228 Py_DECREF(result);
2229 }
2230 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002231}
2232
2233#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002234int Py_AtExit(void (*func)(void))
2235{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002236 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002237 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002238 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002239 return 0;
2240}
2241
2242static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002243call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002244{
Victor Stinner8e91c242019-04-24 17:24:01 +02002245 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002246 /* pop last function from the list */
2247 runtime->nexitfuncs--;
2248 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2249 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2250
2251 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002252 }
Nick Coghland6009512014-11-20 21:39:37 +10002253
2254 fflush(stdout);
2255 fflush(stderr);
2256}
2257
Victor Stinnercfc88312018-08-01 16:41:25 +02002258void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002259Py_Exit(int sts)
2260{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002261 if (Py_FinalizeEx() < 0) {
2262 sts = 120;
2263 }
Nick Coghland6009512014-11-20 21:39:37 +10002264
2265 exit(sts);
2266}
2267
Victor Stinner331a6a52019-05-27 16:39:22 +02002268static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02002269init_signals(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002270{
2271#ifdef SIGPIPE
2272 PyOS_setsig(SIGPIPE, SIG_IGN);
2273#endif
2274#ifdef SIGXFZ
2275 PyOS_setsig(SIGXFZ, SIG_IGN);
2276#endif
2277#ifdef SIGXFSZ
2278 PyOS_setsig(SIGXFSZ, SIG_IGN);
2279#endif
2280 PyOS_InitInterrupts(); /* May imply initsignal() */
Victor Stinnerb45d2592019-06-20 00:05:23 +02002281 if (_PyErr_Occurred(tstate)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002282 return _PyStatus_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002283 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002284 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002285}
2286
2287
2288/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2289 *
2290 * All of the code in this function must only use async-signal-safe functions,
2291 * listed at `man 7 signal` or
2292 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2293 */
2294void
2295_Py_RestoreSignals(void)
2296{
2297#ifdef SIGPIPE
2298 PyOS_setsig(SIGPIPE, SIG_DFL);
2299#endif
2300#ifdef SIGXFZ
2301 PyOS_setsig(SIGXFZ, SIG_DFL);
2302#endif
2303#ifdef SIGXFSZ
2304 PyOS_setsig(SIGXFSZ, SIG_DFL);
2305#endif
2306}
2307
2308
2309/*
2310 * The file descriptor fd is considered ``interactive'' if either
2311 * a) isatty(fd) is TRUE, or
2312 * b) the -i flag was given, and the filename associated with
2313 * the descriptor is NULL or "<stdin>" or "???".
2314 */
2315int
2316Py_FdIsInteractive(FILE *fp, const char *filename)
2317{
2318 if (isatty((int)fileno(fp)))
2319 return 1;
2320 if (!Py_InteractiveFlag)
2321 return 0;
2322 return (filename == NULL) ||
2323 (strcmp(filename, "<stdin>") == 0) ||
2324 (strcmp(filename, "???") == 0);
2325}
2326
2327
Nick Coghland6009512014-11-20 21:39:37 +10002328/* Wrappers around sigaction() or signal(). */
2329
2330PyOS_sighandler_t
2331PyOS_getsig(int sig)
2332{
2333#ifdef HAVE_SIGACTION
2334 struct sigaction context;
2335 if (sigaction(sig, NULL, &context) == -1)
2336 return SIG_ERR;
2337 return context.sa_handler;
2338#else
2339 PyOS_sighandler_t handler;
2340/* Special signal handling for the secure CRT in Visual Studio 2005 */
2341#if defined(_MSC_VER) && _MSC_VER >= 1400
2342 switch (sig) {
2343 /* Only these signals are valid */
2344 case SIGINT:
2345 case SIGILL:
2346 case SIGFPE:
2347 case SIGSEGV:
2348 case SIGTERM:
2349 case SIGBREAK:
2350 case SIGABRT:
2351 break;
2352 /* Don't call signal() with other values or it will assert */
2353 default:
2354 return SIG_ERR;
2355 }
2356#endif /* _MSC_VER && _MSC_VER >= 1400 */
2357 handler = signal(sig, SIG_IGN);
2358 if (handler != SIG_ERR)
2359 signal(sig, handler);
2360 return handler;
2361#endif
2362}
2363
2364/*
2365 * All of the code in this function must only use async-signal-safe functions,
2366 * listed at `man 7 signal` or
2367 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2368 */
2369PyOS_sighandler_t
2370PyOS_setsig(int sig, PyOS_sighandler_t handler)
2371{
2372#ifdef HAVE_SIGACTION
2373 /* Some code in Modules/signalmodule.c depends on sigaction() being
2374 * used here if HAVE_SIGACTION is defined. Fix that if this code
2375 * changes to invalidate that assumption.
2376 */
2377 struct sigaction context, ocontext;
2378 context.sa_handler = handler;
2379 sigemptyset(&context.sa_mask);
2380 context.sa_flags = 0;
2381 if (sigaction(sig, &context, &ocontext) == -1)
2382 return SIG_ERR;
2383 return ocontext.sa_handler;
2384#else
2385 PyOS_sighandler_t oldhandler;
2386 oldhandler = signal(sig, handler);
2387#ifdef HAVE_SIGINTERRUPT
2388 siginterrupt(sig, 1);
2389#endif
2390 return oldhandler;
2391#endif
2392}
2393
2394#ifdef __cplusplus
2395}
2396#endif