blob: 01344db410a0f1caf54673c8dbc90b65a4171c84 [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 Stinner09532fe2019-05-10 23:39:09 +02009#include "pycore_coreconfig.h"
Victor Stinner353933e2018-11-23 13:08:26 +010010#include "pycore_fileutils.h"
Victor Stinner27e2d1f2018-11-01 00:52:28 +010011#include "pycore_hamt.h"
Victor Stinnera1c249c2018-11-01 03:15:58 +010012#include "pycore_pathconfig.h"
Victor Stinner621cebe2018-11-12 16:53:38 +010013#include "pycore_pylifecycle.h"
14#include "pycore_pymem.h"
15#include "pycore_pystate.h"
Victor Stinnered488662019-05-20 00:14:57 +020016#include "pycore_traceback.h"
Nick Coghland6009512014-11-20 21:39:37 +100017#include "grammar.h"
18#include "node.h"
19#include "token.h"
20#include "parsetok.h"
21#include "errcode.h"
22#include "code.h"
23#include "symtable.h"
24#include "ast.h"
25#include "marshal.h"
26#include "osdefs.h"
27#include <locale.h>
28
29#ifdef HAVE_SIGNAL_H
30#include <signal.h>
31#endif
32
33#ifdef MS_WINDOWS
34#include "malloc.h" /* for alloca */
35#endif
36
37#ifdef HAVE_LANGINFO_H
38#include <langinfo.h>
39#endif
40
41#ifdef MS_WINDOWS
42#undef BYTE
43#include "windows.h"
Steve Dower39294992016-08-30 21:22:36 -070044
45extern PyTypeObject PyWindowsConsoleIO_Type;
46#define PyWindowsConsoleIO_Check(op) (PyObject_TypeCheck((op), &PyWindowsConsoleIO_Type))
Nick Coghland6009512014-11-20 21:39:37 +100047#endif
48
49_Py_IDENTIFIER(flush);
50_Py_IDENTIFIER(name);
51_Py_IDENTIFIER(stdin);
52_Py_IDENTIFIER(stdout);
53_Py_IDENTIFIER(stderr);
Eric Snow3f9eee62017-09-15 16:35:20 -060054_Py_IDENTIFIER(threading);
Nick Coghland6009512014-11-20 21:39:37 +100055
56#ifdef __cplusplus
57extern "C" {
58#endif
59
Nick Coghland6009512014-11-20 21:39:37 +100060extern grammar _PyParser_Grammar; /* From graminit.c */
61
62/* Forward */
Victor Stinnerf7e5b562017-11-15 15:48:08 -080063static _PyInitError add_main_module(PyInterpreterState *interp);
Victor Stinner43fc3bb2019-05-02 11:54:20 -040064static _PyInitError init_import_size(void);
Victor Stinner91106cd2017-12-13 12:29:09 +010065static _PyInitError init_sys_streams(PyInterpreterState *interp);
Victor Stinner43fc3bb2019-05-02 11:54:20 -040066static _PyInitError init_signals(void);
Marcel Plch776407f2017-12-20 11:17:58 +010067static void call_py_exitfuncs(PyInterpreterState *);
Nick Coghland6009512014-11-20 21:39:37 +100068static void wait_for_thread_shutdown(void);
Victor Stinner8e91c242019-04-24 17:24:01 +020069static void call_ll_exitfuncs(_PyRuntimeState *runtime);
Nick Coghland6009512014-11-20 21:39:37 +100070
Gregory P. Smith38f11cc2019-02-16 12:57:40 -080071int _Py_UnhandledKeyboardInterrupt = 0;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080072_PyRuntimeState _PyRuntime = _PyRuntimeState_INIT;
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010073static int runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060074
Victor Stinnerf7e5b562017-11-15 15:48:08 -080075_PyInitError
Eric Snow2ebc5ce2017-09-07 23:51:28 -060076_PyRuntime_Initialize(void)
77{
78 /* XXX We only initialize once in the process, which aligns with
79 the static initialization of the former globals now found in
80 _PyRuntime. However, _PyRuntime *should* be initialized with
81 every Py_Initialize() call, but doing so breaks the runtime.
82 This is because the runtime state is not properly finalized
83 currently. */
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010084 if (runtime_initialized) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -080085 return _Py_INIT_OK();
86 }
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010087 runtime_initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080088
89 return _PyRuntimeState_Init(&_PyRuntime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -060090}
91
92void
93_PyRuntime_Finalize(void)
94{
95 _PyRuntimeState_Fini(&_PyRuntime);
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010096 runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060097}
98
99int
100_Py_IsFinalizing(void)
101{
102 return _PyRuntime.finalizing != NULL;
103}
104
Nick Coghland6009512014-11-20 21:39:37 +1000105/* Hack to force loading of object files */
106int (*_PyOS_mystrnicmp_hack)(const char *, const char *, Py_ssize_t) = \
107 PyOS_mystrnicmp; /* Python/pystrcmp.o */
108
109/* PyModule_GetWarningsModule is no longer necessary as of 2.6
110since _warnings is builtin. This API should not be used. */
111PyObject *
112PyModule_GetWarningsModule(void)
113{
114 return PyImport_ImportModule("warnings");
115}
116
Eric Snowc7ec9982017-05-23 23:00:52 -0700117
Eric Snow1abcf672017-05-23 21:46:51 -0700118/* APIs to access the initialization flags
119 *
120 * Can be called prior to Py_Initialize.
121 */
Nick Coghland6009512014-11-20 21:39:37 +1000122
Eric Snow1abcf672017-05-23 21:46:51 -0700123int
124_Py_IsCoreInitialized(void)
125{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600126 return _PyRuntime.core_initialized;
Eric Snow1abcf672017-05-23 21:46:51 -0700127}
Nick Coghland6009512014-11-20 21:39:37 +1000128
129int
130Py_IsInitialized(void)
131{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600132 return _PyRuntime.initialized;
Nick Coghland6009512014-11-20 21:39:37 +1000133}
134
Nick Coghlan6ea41862017-06-11 13:16:15 +1000135
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000136/* Global initializations. Can be undone by Py_FinalizeEx(). Don't
137 call this twice without an intervening Py_FinalizeEx() call. When
Nick Coghland6009512014-11-20 21:39:37 +1000138 initializations fail, a fatal error is issued and the function does
139 not return. On return, the first thread and interpreter state have
140 been created.
141
142 Locking: you must hold the interpreter lock while calling this.
143 (If the lock has not yet been initialized, that's equivalent to
144 having the lock, but you cannot use multiple threads.)
145
146*/
147
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800148static _PyInitError
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400149init_importlib(PyInterpreterState *interp, PyObject *sysmod)
Nick Coghland6009512014-11-20 21:39:37 +1000150{
151 PyObject *importlib;
152 PyObject *impmod;
Nick Coghland6009512014-11-20 21:39:37 +1000153 PyObject *value;
Victor Stinnerc96be812019-05-14 17:34:56 +0200154 int verbose = interp->core_config.verbose;
Nick Coghland6009512014-11-20 21:39:37 +1000155
156 /* Import _importlib through its frozen version, _frozen_importlib. */
157 if (PyImport_ImportFrozenModule("_frozen_importlib") <= 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800158 return _Py_INIT_ERR("can't import _frozen_importlib");
Nick Coghland6009512014-11-20 21:39:37 +1000159 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200160 else if (verbose) {
Nick Coghland6009512014-11-20 21:39:37 +1000161 PySys_FormatStderr("import _frozen_importlib # frozen\n");
162 }
163 importlib = PyImport_AddModule("_frozen_importlib");
164 if (importlib == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800165 return _Py_INIT_ERR("couldn't get _frozen_importlib from sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000166 }
167 interp->importlib = importlib;
168 Py_INCREF(interp->importlib);
169
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300170 interp->import_func = PyDict_GetItemString(interp->builtins, "__import__");
171 if (interp->import_func == NULL)
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800172 return _Py_INIT_ERR("__import__ not found");
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300173 Py_INCREF(interp->import_func);
174
Victor Stinnercd6e6942015-09-18 09:11:57 +0200175 /* Import the _imp module */
Benjamin Petersonc65ef772018-01-29 11:33:57 -0800176 impmod = PyInit__imp();
Nick Coghland6009512014-11-20 21:39:37 +1000177 if (impmod == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800178 return _Py_INIT_ERR("can't import _imp");
Nick Coghland6009512014-11-20 21:39:37 +1000179 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200180 else if (verbose) {
Victor Stinnercd6e6942015-09-18 09:11:57 +0200181 PySys_FormatStderr("import _imp # builtin\n");
Nick Coghland6009512014-11-20 21:39:37 +1000182 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600183 if (_PyImport_SetModuleString("_imp", impmod) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800184 return _Py_INIT_ERR("can't save _imp to sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000185 }
186
Victor Stinnercd6e6942015-09-18 09:11:57 +0200187 /* Install importlib as the implementation of import */
Nick Coghland6009512014-11-20 21:39:37 +1000188 value = PyObject_CallMethod(importlib, "_install", "OO", sysmod, impmod);
189 if (value == NULL) {
190 PyErr_Print();
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800191 return _Py_INIT_ERR("importlib install failed");
Nick Coghland6009512014-11-20 21:39:37 +1000192 }
193 Py_DECREF(value);
194 Py_DECREF(impmod);
195
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800196 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000197}
198
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800199static _PyInitError
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400200init_importlib_external(PyInterpreterState *interp)
Eric Snow1abcf672017-05-23 21:46:51 -0700201{
202 PyObject *value;
203 value = PyObject_CallMethod(interp->importlib,
204 "_install_external_importers", "");
205 if (value == NULL) {
206 PyErr_Print();
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800207 return _Py_INIT_ERR("external importer setup failed");
Eric Snow1abcf672017-05-23 21:46:51 -0700208 }
Stéphane Wirtelab1cb802017-06-08 13:13:20 +0200209 Py_DECREF(value);
Victor Stinner410b85a2019-05-13 17:12:45 +0200210 return _PyImportZip_Init(interp);
Eric Snow1abcf672017-05-23 21:46:51 -0700211}
Nick Coghland6009512014-11-20 21:39:37 +1000212
Nick Coghlan6ea41862017-06-11 13:16:15 +1000213/* Helper functions to better handle the legacy C locale
214 *
215 * The legacy C locale assumes ASCII as the default text encoding, which
216 * causes problems not only for the CPython runtime, but also other
217 * components like GNU readline.
218 *
219 * Accordingly, when the CLI detects it, it attempts to coerce it to a
220 * more capable UTF-8 based alternative as follows:
221 *
222 * if (_Py_LegacyLocaleDetected()) {
223 * _Py_CoerceLegacyLocale();
224 * }
225 *
226 * See the documentation of the PYTHONCOERCECLOCALE setting for more details.
227 *
228 * Locale coercion also impacts the default error handler for the standard
229 * streams: while the usual default is "strict", the default for the legacy
230 * C locale and for any of the coercion target locales is "surrogateescape".
231 */
232
233int
Victor Stinner0f721472019-05-20 17:16:38 +0200234_Py_LegacyLocaleDetected(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000235{
236#ifndef MS_WINDOWS
Victor Stinner0f721472019-05-20 17:16:38 +0200237 if (!warn) {
238 const char *locale_override = getenv("LC_ALL");
239 if (locale_override != NULL && *locale_override != '\0') {
240 /* Don't coerce C locale if the LC_ALL environment variable
241 is set */
242 return 0;
243 }
244 }
245
Nick Coghlan6ea41862017-06-11 13:16:15 +1000246 /* On non-Windows systems, the C locale is considered a legacy locale */
Nick Coghlaneb817952017-06-18 12:29:42 +1000247 /* XXX (ncoghlan): some platforms (notably Mac OS X) don't appear to treat
248 * the POSIX locale as a simple alias for the C locale, so
249 * we may also want to check for that explicitly.
250 */
Nick Coghlan6ea41862017-06-11 13:16:15 +1000251 const char *ctype_loc = setlocale(LC_CTYPE, NULL);
252 return ctype_loc != NULL && strcmp(ctype_loc, "C") == 0;
253#else
254 /* Windows uses code pages instead of locales, so no locale is legacy */
255 return 0;
256#endif
257}
258
Nick Coghlaneb817952017-06-18 12:29:42 +1000259static const char *_C_LOCALE_WARNING =
260 "Python runtime initialized with LC_CTYPE=C (a locale with default ASCII "
261 "encoding), which may cause Unicode compatibility problems. Using C.UTF-8, "
262 "C.utf8, or UTF-8 (if available) as alternative Unicode-compatible "
263 "locales is recommended.\n";
264
Nick Coghlaneb817952017-06-18 12:29:42 +1000265static void
Victor Stinner43125222019-04-24 18:23:53 +0200266emit_stderr_warning_for_legacy_locale(_PyRuntimeState *runtime)
Nick Coghlaneb817952017-06-18 12:29:42 +1000267{
Victor Stinner43125222019-04-24 18:23:53 +0200268 const _PyPreConfig *preconfig = &runtime->preconfig;
Victor Stinner0f721472019-05-20 17:16:38 +0200269 if (preconfig->coerce_c_locale_warn && _Py_LegacyLocaleDetected(1)) {
Victor Stinnercf215042018-08-29 22:56:06 +0200270 PySys_FormatStderr("%s", _C_LOCALE_WARNING);
Nick Coghlaneb817952017-06-18 12:29:42 +1000271 }
272}
273
Nick Coghlan6ea41862017-06-11 13:16:15 +1000274typedef struct _CandidateLocale {
275 const char *locale_name; /* The locale to try as a coercion target */
276} _LocaleCoercionTarget;
277
278static _LocaleCoercionTarget _TARGET_LOCALES[] = {
279 {"C.UTF-8"},
280 {"C.utf8"},
Nick Coghlan18974c32017-06-30 00:48:14 +1000281 {"UTF-8"},
Nick Coghlan6ea41862017-06-11 13:16:15 +1000282 {NULL}
283};
284
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200285
286int
287_Py_IsLocaleCoercionTarget(const char *ctype_loc)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000288{
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200289 const _LocaleCoercionTarget *target = NULL;
290 for (target = _TARGET_LOCALES; target->locale_name; target++) {
291 if (strcmp(ctype_loc, target->locale_name) == 0) {
292 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000293 }
Victor Stinner124b9eb2018-08-29 01:29:06 +0200294 }
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200295 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000296}
297
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200298
Nick Coghlan6ea41862017-06-11 13:16:15 +1000299#ifdef PY_COERCE_C_LOCALE
Victor Stinner94540602017-12-16 04:54:22 +0100300static const char C_LOCALE_COERCION_WARNING[] =
Nick Coghlan6ea41862017-06-11 13:16:15 +1000301 "Python detected LC_CTYPE=C: LC_CTYPE coerced to %.20s (set another locale "
302 "or PYTHONCOERCECLOCALE=0 to disable this locale coercion behavior).\n";
303
Victor Stinner0f721472019-05-20 17:16:38 +0200304static int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200305_coerce_default_locale_settings(int warn, const _LocaleCoercionTarget *target)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000306{
307 const char *newloc = target->locale_name;
308
309 /* Reset locale back to currently configured defaults */
xdegaye1588be62017-11-12 12:45:59 +0100310 _Py_SetLocaleFromEnv(LC_ALL);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000311
312 /* Set the relevant locale environment variable */
313 if (setenv("LC_CTYPE", newloc, 1)) {
314 fprintf(stderr,
315 "Error setting LC_CTYPE, skipping C locale coercion\n");
Victor Stinner0f721472019-05-20 17:16:38 +0200316 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000317 }
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200318 if (warn) {
Victor Stinner94540602017-12-16 04:54:22 +0100319 fprintf(stderr, C_LOCALE_COERCION_WARNING, newloc);
Nick Coghlaneb817952017-06-18 12:29:42 +1000320 }
Nick Coghlan6ea41862017-06-11 13:16:15 +1000321
322 /* Reconfigure with the overridden environment variables */
xdegaye1588be62017-11-12 12:45:59 +0100323 _Py_SetLocaleFromEnv(LC_ALL);
Victor Stinner0f721472019-05-20 17:16:38 +0200324 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000325}
326#endif
327
Victor Stinner0f721472019-05-20 17:16:38 +0200328int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200329_Py_CoerceLegacyLocale(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000330{
Victor Stinner0f721472019-05-20 17:16:38 +0200331 int coerced = 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000332#ifdef PY_COERCE_C_LOCALE
Victor Stinner8ea09112018-09-03 17:05:18 +0200333 char *oldloc = NULL;
334
335 oldloc = _PyMem_RawStrdup(setlocale(LC_CTYPE, NULL));
336 if (oldloc == NULL) {
Victor Stinner0f721472019-05-20 17:16:38 +0200337 return coerced;
Victor Stinner8ea09112018-09-03 17:05:18 +0200338 }
339
Victor Stinner94540602017-12-16 04:54:22 +0100340 const char *locale_override = getenv("LC_ALL");
341 if (locale_override == NULL || *locale_override == '\0') {
342 /* LC_ALL is also not set (or is set to an empty string) */
343 const _LocaleCoercionTarget *target = NULL;
344 for (target = _TARGET_LOCALES; target->locale_name; target++) {
345 const char *new_locale = setlocale(LC_CTYPE,
346 target->locale_name);
347 if (new_locale != NULL) {
Victor Stinnere2510952019-05-02 11:28:57 -0400348#if !defined(_Py_FORCE_UTF8_LOCALE) && defined(HAVE_LANGINFO_H) && defined(CODESET)
Victor Stinner94540602017-12-16 04:54:22 +0100349 /* Also ensure that nl_langinfo works in this locale */
350 char *codeset = nl_langinfo(CODESET);
351 if (!codeset || *codeset == '\0') {
352 /* CODESET is not set or empty, so skip coercion */
353 new_locale = NULL;
354 _Py_SetLocaleFromEnv(LC_CTYPE);
355 continue;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000356 }
Victor Stinner94540602017-12-16 04:54:22 +0100357#endif
358 /* Successfully configured locale, so make it the default */
Victor Stinner0f721472019-05-20 17:16:38 +0200359 coerced = _coerce_default_locale_settings(warn, target);
Victor Stinner8ea09112018-09-03 17:05:18 +0200360 goto done;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000361 }
362 }
363 }
364 /* No C locale warning here, as Py_Initialize will emit one later */
Victor Stinner8ea09112018-09-03 17:05:18 +0200365
366 setlocale(LC_CTYPE, oldloc);
367
368done:
369 PyMem_RawFree(oldloc);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000370#endif
Victor Stinner0f721472019-05-20 17:16:38 +0200371 return coerced;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000372}
373
xdegaye1588be62017-11-12 12:45:59 +0100374/* _Py_SetLocaleFromEnv() is a wrapper around setlocale(category, "") to
375 * isolate the idiosyncrasies of different libc implementations. It reads the
376 * appropriate environment variable and uses its value to select the locale for
377 * 'category'. */
378char *
379_Py_SetLocaleFromEnv(int category)
380{
Victor Stinner353933e2018-11-23 13:08:26 +0100381 char *res;
xdegaye1588be62017-11-12 12:45:59 +0100382#ifdef __ANDROID__
383 const char *locale;
384 const char **pvar;
385#ifdef PY_COERCE_C_LOCALE
386 const char *coerce_c_locale;
387#endif
388 const char *utf8_locale = "C.UTF-8";
389 const char *env_var_set[] = {
390 "LC_ALL",
391 "LC_CTYPE",
392 "LANG",
393 NULL,
394 };
395
396 /* Android setlocale(category, "") doesn't check the environment variables
397 * and incorrectly sets the "C" locale at API 24 and older APIs. We only
398 * check the environment variables listed in env_var_set. */
399 for (pvar=env_var_set; *pvar; pvar++) {
400 locale = getenv(*pvar);
401 if (locale != NULL && *locale != '\0') {
402 if (strcmp(locale, utf8_locale) == 0 ||
403 strcmp(locale, "en_US.UTF-8") == 0) {
404 return setlocale(category, utf8_locale);
405 }
406 return setlocale(category, "C");
407 }
408 }
409
410 /* Android uses UTF-8, so explicitly set the locale to C.UTF-8 if none of
411 * LC_ALL, LC_CTYPE, or LANG is set to a non-empty string.
412 * Quote from POSIX section "8.2 Internationalization Variables":
413 * "4. If the LANG environment variable is not set or is set to the empty
414 * string, the implementation-defined default locale shall be used." */
415
416#ifdef PY_COERCE_C_LOCALE
417 coerce_c_locale = getenv("PYTHONCOERCECLOCALE");
418 if (coerce_c_locale == NULL || strcmp(coerce_c_locale, "0") != 0) {
419 /* Some other ported code may check the environment variables (e.g. in
420 * extension modules), so we make sure that they match the locale
421 * configuration */
422 if (setenv("LC_CTYPE", utf8_locale, 1)) {
423 fprintf(stderr, "Warning: failed setting the LC_CTYPE "
424 "environment variable to %s\n", utf8_locale);
425 }
426 }
427#endif
Victor Stinner353933e2018-11-23 13:08:26 +0100428 res = setlocale(category, utf8_locale);
429#else /* !defined(__ANDROID__) */
430 res = setlocale(category, "");
431#endif
432 _Py_ResetForceASCII();
433 return res;
xdegaye1588be62017-11-12 12:45:59 +0100434}
435
Nick Coghlan6ea41862017-06-11 13:16:15 +1000436
Eric Snow1abcf672017-05-23 21:46:51 -0700437/* Global initializations. Can be undone by Py_Finalize(). Don't
438 call this twice without an intervening Py_Finalize() call.
439
Victor Stinner484f20d2019-03-27 02:04:16 +0100440 Every call to _Py_InitializeFromConfig, Py_Initialize or Py_InitializeEx
Eric Snow1abcf672017-05-23 21:46:51 -0700441 must have a corresponding call to Py_Finalize.
442
443 Locking: you must hold the interpreter lock while calling these APIs.
444 (If the lock has not yet been initialized, that's equivalent to
445 having the lock, but you cannot use multiple threads.)
446
447*/
448
Victor Stinner1dc6e392018-07-25 02:49:17 +0200449static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200450_Py_Initialize_ReconfigureCore(_PyRuntimeState *runtime,
451 PyInterpreterState **interp_p,
Victor Stinner1dc6e392018-07-25 02:49:17 +0200452 const _PyCoreConfig *core_config)
453{
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200454 _PyInitError err;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100455 PyThreadState *tstate = _PyThreadState_GET();
456 if (!tstate) {
457 return _Py_INIT_ERR("failed to read thread state");
458 }
459
460 PyInterpreterState *interp = tstate->interp;
461 if (interp == NULL) {
462 return _Py_INIT_ERR("can't make main interpreter");
463 }
464 *interp_p = interp;
465
Victor Stinner43125222019-04-24 18:23:53 +0200466 _PyCoreConfig_Write(core_config, runtime);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200467
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200468 err = _PyCoreConfig_Copy(&interp->core_config, core_config);
469 if (_Py_INIT_FAILED(err)) {
470 return err;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200471 }
472 core_config = &interp->core_config;
473
474 if (core_config->_install_importlib) {
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200475 err = _PyCoreConfig_SetPathConfig(core_config);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200476 if (_Py_INIT_FAILED(err)) {
477 return err;
478 }
479 }
480 return _Py_INIT_OK();
481}
482
483
Victor Stinner1dc6e392018-07-25 02:49:17 +0200484static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200485pycore_init_runtime(_PyRuntimeState *runtime,
486 const _PyCoreConfig *core_config)
Nick Coghland6009512014-11-20 21:39:37 +1000487{
Victor Stinner43125222019-04-24 18:23:53 +0200488 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +0200489 return _Py_INIT_ERR("main interpreter already initialized");
490 }
Victor Stinnerda273412017-12-15 01:46:02 +0100491
Victor Stinner43125222019-04-24 18:23:53 +0200492 _PyCoreConfig_Write(core_config, runtime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600493
Eric Snow1abcf672017-05-23 21:46:51 -0700494 /* Py_Finalize leaves _Py_Finalizing set in order to help daemon
495 * threads behave a little more gracefully at interpreter shutdown.
496 * We clobber it here so the new interpreter can start with a clean
497 * slate.
498 *
499 * However, this may still lead to misbehaviour if there are daemon
500 * threads still hanging around from a previous Py_Initialize/Finalize
501 * pair :(
502 */
Victor Stinner43125222019-04-24 18:23:53 +0200503 runtime->finalizing = NULL;
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600504
Victor Stinner43125222019-04-24 18:23:53 +0200505 _PyInitError err = _Py_HashRandomization_Init(core_config);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800506 if (_Py_INIT_FAILED(err)) {
507 return err;
508 }
509
Victor Stinner43125222019-04-24 18:23:53 +0200510 err = _PyInterpreterState_Enable(runtime);
Victor Stinnera7368ac2017-11-15 18:11:45 -0800511 if (_Py_INIT_FAILED(err)) {
512 return err;
513 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100514 return _Py_INIT_OK();
515}
Victor Stinnera7368ac2017-11-15 18:11:45 -0800516
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100517
518static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200519pycore_create_interpreter(_PyRuntimeState *runtime,
520 const _PyCoreConfig *core_config,
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100521 PyInterpreterState **interp_p)
522{
523 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnerda273412017-12-15 01:46:02 +0100524 if (interp == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800525 return _Py_INIT_ERR("can't make main interpreter");
Victor Stinnerda273412017-12-15 01:46:02 +0100526 }
Victor Stinner1dc6e392018-07-25 02:49:17 +0200527 *interp_p = interp;
Victor Stinnerda273412017-12-15 01:46:02 +0100528
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200529 _PyInitError err = _PyCoreConfig_Copy(&interp->core_config, core_config);
530 if (_Py_INIT_FAILED(err)) {
531 return err;
Victor Stinnerda273412017-12-15 01:46:02 +0100532 }
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200533 core_config = &interp->core_config;
Nick Coghland6009512014-11-20 21:39:37 +1000534
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200535 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +1000536 if (tstate == NULL)
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800537 return _Py_INIT_ERR("can't make first thread");
Nick Coghland6009512014-11-20 21:39:37 +1000538 (void) PyThreadState_Swap(tstate);
539
Victor Stinner99fcc612019-04-29 13:04:07 +0200540 /* We can't call _PyEval_FiniThreads() in Py_FinalizeEx because
541 destroying the GIL might fail when it is being referenced from
542 another running thread (see issue #9901).
Nick Coghland6009512014-11-20 21:39:37 +1000543 Instead we destroy the previously created GIL here, which ensures
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000544 that we can call Py_Initialize / Py_FinalizeEx multiple times. */
Victor Stinner09532fe2019-05-10 23:39:09 +0200545 _PyEval_FiniThreads(&runtime->ceval);
Victor Stinner2914bb32018-01-29 11:57:45 +0100546
Nick Coghland6009512014-11-20 21:39:37 +1000547 /* Auto-thread-state API */
Victor Stinner43125222019-04-24 18:23:53 +0200548 _PyGILState_Init(runtime, interp, tstate);
Nick Coghland6009512014-11-20 21:39:37 +1000549
Victor Stinner2914bb32018-01-29 11:57:45 +0100550 /* Create the GIL */
551 PyEval_InitThreads();
552
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100553 return _Py_INIT_OK();
554}
Nick Coghland6009512014-11-20 21:39:37 +1000555
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100556
557static _PyInitError
558pycore_init_types(void)
559{
Victor Stinnerab672812019-01-23 15:04:40 +0100560 _PyInitError err = _PyTypes_Init();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100561 if (_Py_INIT_FAILED(err)) {
562 return err;
563 }
564
565 err = _PyUnicode_Init();
566 if (_Py_INIT_FAILED(err)) {
567 return err;
568 }
569
570 if (_PyStructSequence_Init() < 0) {
571 return _Py_INIT_ERR("can't initialize structseq");
572 }
573
574 if (!_PyLong_Init()) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800575 return _Py_INIT_ERR("can't init longs");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100576 }
Nick Coghland6009512014-11-20 21:39:37 +1000577
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100578 err = _PyExc_Init();
579 if (_Py_INIT_FAILED(err)) {
580 return err;
581 }
582
583 if (!_PyFloat_Init()) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800584 return _Py_INIT_ERR("can't init float");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100585 }
Nick Coghland6009512014-11-20 21:39:37 +1000586
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100587 if (!_PyContext_Init()) {
588 return _Py_INIT_ERR("can't init context");
589 }
590 return _Py_INIT_OK();
591}
592
593
594static _PyInitError
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100595pycore_init_builtins(PyInterpreterState *interp)
596{
597 PyObject *bimod = _PyBuiltin_Init();
598 if (bimod == NULL) {
599 return _Py_INIT_ERR("can't initialize builtins modules");
600 }
601 _PyImport_FixupBuiltin(bimod, "builtins", interp->modules);
602
603 interp->builtins = PyModule_GetDict(bimod);
604 if (interp->builtins == NULL) {
605 return _Py_INIT_ERR("can't initialize builtins dict");
606 }
607 Py_INCREF(interp->builtins);
608
609 _PyInitError err = _PyBuiltins_AddExceptions(bimod);
610 if (_Py_INIT_FAILED(err)) {
611 return err;
612 }
613 return _Py_INIT_OK();
614}
615
616
617static _PyInitError
618pycore_init_import_warnings(PyInterpreterState *interp, PyObject *sysmod)
619{
620 _PyInitError err = _PyImport_Init(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800621 if (_Py_INIT_FAILED(err)) {
622 return err;
623 }
Nick Coghland6009512014-11-20 21:39:37 +1000624
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800625 err = _PyImportHooks_Init();
626 if (_Py_INIT_FAILED(err)) {
627 return err;
628 }
Nick Coghland6009512014-11-20 21:39:37 +1000629
630 /* Initialize _warnings. */
Victor Stinner5d862462017-12-19 11:35:58 +0100631 if (_PyWarnings_Init() == NULL) {
Victor Stinner1f151112017-11-23 10:43:14 +0100632 return _Py_INIT_ERR("can't initialize warnings");
633 }
Nick Coghland6009512014-11-20 21:39:37 +1000634
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100635 if (interp->core_config._install_importlib) {
636 err = _PyCoreConfig_SetPathConfig(&interp->core_config);
Victor Stinnerb1147e42018-07-21 02:06:16 +0200637 if (_Py_INIT_FAILED(err)) {
638 return err;
639 }
640 }
641
Eric Snow1abcf672017-05-23 21:46:51 -0700642 /* This call sets up builtin and frozen import support */
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100643 if (interp->core_config._install_importlib) {
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400644 err = init_importlib(interp, sysmod);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800645 if (_Py_INIT_FAILED(err)) {
646 return err;
647 }
Eric Snow1abcf672017-05-23 21:46:51 -0700648 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100649 return _Py_INIT_OK();
650}
651
652
653static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200654_Py_InitializeCore_impl(_PyRuntimeState *runtime,
655 PyInterpreterState **interp_p,
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100656 const _PyCoreConfig *core_config)
657{
658 PyInterpreterState *interp;
659
Victor Stinner43125222019-04-24 18:23:53 +0200660 _PyCoreConfig_Write(core_config, runtime);
Victor Stinner20004952019-03-26 02:31:11 +0100661
Victor Stinner43125222019-04-24 18:23:53 +0200662 _PyInitError err = pycore_init_runtime(runtime, core_config);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100663 if (_Py_INIT_FAILED(err)) {
664 return err;
665 }
666
Victor Stinner43125222019-04-24 18:23:53 +0200667 err = pycore_create_interpreter(runtime, core_config, &interp);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100668 if (_Py_INIT_FAILED(err)) {
669 return err;
670 }
671 core_config = &interp->core_config;
672 *interp_p = interp;
673
674 err = pycore_init_types();
675 if (_Py_INIT_FAILED(err)) {
676 return err;
677 }
678
679 PyObject *sysmod;
Victor Stinner43125222019-04-24 18:23:53 +0200680 err = _PySys_Create(runtime, interp, &sysmod);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100681 if (_Py_INIT_FAILED(err)) {
682 return err;
683 }
684
685 err = pycore_init_builtins(interp);
686 if (_Py_INIT_FAILED(err)) {
687 return err;
688 }
689
690 err = pycore_init_import_warnings(interp, sysmod);
691 if (_Py_INIT_FAILED(err)) {
692 return err;
693 }
Eric Snow1abcf672017-05-23 21:46:51 -0700694
695 /* Only when we get here is the runtime core fully initialized */
Victor Stinner43125222019-04-24 18:23:53 +0200696 runtime->core_initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800697 return _Py_INIT_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700698}
699
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100700
Victor Stinner70005ac2019-05-02 15:25:34 -0400701_PyInitError
702_Py_PreInitializeFromPyArgv(const _PyPreConfig *src_config, const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100703{
704 _PyInitError err;
705
Victor Stinner6d1c4672019-05-20 11:02:00 +0200706 if (src_config == NULL) {
707 return _Py_INIT_ERR("preinitialization config is NULL");
708 }
709
Victor Stinnerf29084d2019-03-20 02:20:13 +0100710 err = _PyRuntime_Initialize();
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100711 if (_Py_INIT_FAILED(err)) {
Victor Stinner5ac27a52019-03-27 13:40:14 +0100712 return err;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100713 }
Victor Stinner43125222019-04-24 18:23:53 +0200714 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100715
Victor Stinner43125222019-04-24 18:23:53 +0200716 if (runtime->pre_initialized) {
Victor Stinnerf72346c2019-03-25 17:54:58 +0100717 /* If it's already configured: ignored the new configuration */
Victor Stinner5ac27a52019-03-27 13:40:14 +0100718 return _Py_INIT_OK();
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100719 }
720
Victor Stinnercab5d072019-05-17 19:01:14 +0200721 _PyPreConfig config;
Victor Stinner6d1c4672019-05-20 11:02:00 +0200722 _PyPreConfig_InitFromPreConfig(&config, src_config);
Victor Stinnerf72346c2019-03-25 17:54:58 +0100723
Victor Stinner5ac27a52019-03-27 13:40:14 +0100724 err = _PyPreConfig_Read(&config, args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100725 if (_Py_INIT_FAILED(err)) {
Victor Stinnerb16b4e42019-05-17 15:20:52 +0200726 return err;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100727 }
728
Victor Stinner5ac27a52019-03-27 13:40:14 +0100729 err = _PyPreConfig_Write(&config);
Victor Stinnerf72346c2019-03-25 17:54:58 +0100730 if (_Py_INIT_FAILED(err)) {
Victor Stinnerb16b4e42019-05-17 15:20:52 +0200731 return err;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100732 }
733
Victor Stinner43125222019-04-24 18:23:53 +0200734 runtime->pre_initialized = 1;
Victor Stinnerb16b4e42019-05-17 15:20:52 +0200735 return _Py_INIT_OK();
Victor Stinnerf72346c2019-03-25 17:54:58 +0100736}
737
Victor Stinner70005ac2019-05-02 15:25:34 -0400738
Victor Stinnerf72346c2019-03-25 17:54:58 +0100739_PyInitError
Victor Stinnerb5947842019-05-18 00:38:16 +0200740_Py_PreInitializeFromArgs(const _PyPreConfig *src_config, Py_ssize_t argc, char **argv)
Victor Stinnerf72346c2019-03-25 17:54:58 +0100741{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100742 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400743 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100744}
745
746
747_PyInitError
Victor Stinnerb5947842019-05-18 00:38:16 +0200748_Py_PreInitializeFromWideArgs(const _PyPreConfig *src_config, Py_ssize_t argc, wchar_t **argv)
Victor Stinner20004952019-03-26 02:31:11 +0100749{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100750 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400751 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinner20004952019-03-26 02:31:11 +0100752}
753
754
755_PyInitError
Victor Stinner5ac27a52019-03-27 13:40:14 +0100756_Py_PreInitialize(const _PyPreConfig *src_config)
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100757{
Victor Stinner70005ac2019-05-02 15:25:34 -0400758 return _Py_PreInitializeFromPyArgv(src_config, NULL);
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100759}
760
761
762_PyInitError
Victor Stinner70005ac2019-05-02 15:25:34 -0400763_Py_PreInitializeFromCoreConfig(const _PyCoreConfig *coreconfig,
764 const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100765{
Victor Stinner6d1c4672019-05-20 11:02:00 +0200766 assert(coreconfig != NULL);
767
768 _PyInitError err = _PyRuntime_Initialize();
769 if (_Py_INIT_FAILED(err)) {
770 return err;
771 }
772 _PyRuntimeState *runtime = &_PyRuntime;
773
774 if (runtime->pre_initialized) {
775 /* Already initialized: do nothing */
776 return _Py_INIT_OK();
Victor Stinner70005ac2019-05-02 15:25:34 -0400777 }
Victor Stinnercab5d072019-05-17 19:01:14 +0200778
Victor Stinner6d1c4672019-05-20 11:02:00 +0200779 _PyPreConfig preconfig;
780 _PyPreConfig_InitFromCoreConfig(&preconfig, coreconfig);
781
782 if (!coreconfig->parse_argv) {
783 return _Py_PreInitialize(&preconfig);
784 }
785 else if (args == NULL) {
Victor Stinnercab5d072019-05-17 19:01:14 +0200786 _PyArgv config_args = {
787 .use_bytes_argv = 0,
788 .argc = coreconfig->argv.length,
789 .wchar_argv = coreconfig->argv.items};
Victor Stinner6d1c4672019-05-20 11:02:00 +0200790 return _Py_PreInitializeFromPyArgv(&preconfig, &config_args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200791 }
792 else {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200793 return _Py_PreInitializeFromPyArgv(&preconfig, args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200794 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100795}
796
797
798static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200799pyinit_coreconfig(_PyRuntimeState *runtime,
800 _PyCoreConfig *config,
Victor Stinner5ac27a52019-03-27 13:40:14 +0100801 const _PyCoreConfig *src_config,
802 const _PyArgv *args,
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100803 PyInterpreterState **interp_p)
804{
Victor Stinner6d1c4672019-05-20 11:02:00 +0200805 assert(src_config != NULL);
Victor Stinner5f38b842019-05-01 02:30:12 +0200806
Victor Stinner6d1c4672019-05-20 11:02:00 +0200807 _PyInitError err = _PyCoreConfig_Copy(config, src_config);
808 if (_Py_INIT_FAILED(err)) {
809 return err;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100810 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100811
Victor Stinner5f38b842019-05-01 02:30:12 +0200812 if (args) {
813 err = _PyCoreConfig_SetPyArgv(config, args);
814 if (_Py_INIT_FAILED(err)) {
815 return err;
816 }
817 }
818
819 err = _PyCoreConfig_Read(config);
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100820 if (_Py_INIT_FAILED(err)) {
821 return err;
822 }
823
Victor Stinner43125222019-04-24 18:23:53 +0200824 if (!runtime->core_initialized) {
825 return _Py_InitializeCore_impl(runtime, interp_p, config);
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100826 }
827 else {
Victor Stinner43125222019-04-24 18:23:53 +0200828 return _Py_Initialize_ReconfigureCore(runtime, interp_p, config);
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100829 }
830}
831
832
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100833/* Begin interpreter initialization
834 *
835 * On return, the first thread and interpreter state have been created,
836 * but the compiler, signal handling, multithreading and
837 * multiple interpreter support, and codec infrastructure are not yet
838 * available.
839 *
840 * The import system will support builtin and frozen modules only.
841 * The only supported io is writing to sys.stderr
842 *
843 * If any operation invoked by this function fails, a fatal error is
844 * issued and the function does not return.
845 *
846 * Any code invoked from this function should *not* assume it has access
847 * to the Python C API (unless the API is explicitly listed as being
848 * safe to call without calling Py_Initialize first)
849 */
Victor Stinner484f20d2019-03-27 02:04:16 +0100850static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200851_Py_InitializeCore(_PyRuntimeState *runtime,
852 const _PyCoreConfig *src_config,
Victor Stinner5ac27a52019-03-27 13:40:14 +0100853 const _PyArgv *args,
Victor Stinnerf8ba6f52019-03-26 16:58:50 +0100854 PyInterpreterState **interp_p)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200855{
Victor Stinnerd929f182019-03-27 18:28:46 +0100856 _PyInitError err;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200857
Victor Stinner70005ac2019-05-02 15:25:34 -0400858 err = _Py_PreInitializeFromCoreConfig(src_config, args);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200859 if (_Py_INIT_FAILED(err)) {
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100860 return err;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200861 }
862
Victor Stinnercab5d072019-05-17 19:01:14 +0200863 _PyCoreConfig local_config;
864 _PyCoreConfig_Init(&local_config);
Victor Stinner43125222019-04-24 18:23:53 +0200865 err = pyinit_coreconfig(runtime, &local_config, src_config, args, interp_p);
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100866 _PyCoreConfig_Clear(&local_config);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200867 return err;
868}
869
Victor Stinner5ac27a52019-03-27 13:40:14 +0100870
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200871/* Py_Initialize() has already been called: update the main interpreter
872 configuration. Example of bpo-34008: Py_Main() called after
873 Py_Initialize(). */
874static _PyInitError
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100875_Py_ReconfigureMainInterpreter(PyInterpreterState *interp)
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200876{
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100877 _PyCoreConfig *core_config = &interp->core_config;
878
879 PyObject *argv = _PyWstrList_AsList(&core_config->argv);
880 if (argv == NULL) {
881 return _Py_INIT_NO_MEMORY(); \
882 }
883
884 int res = PyDict_SetItemString(interp->sysdict, "argv", argv);
885 Py_DECREF(argv);
886 if (res < 0) {
887 return _Py_INIT_ERR("fail to set sys.argv");
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200888 }
889 return _Py_INIT_OK();
890}
891
Eric Snowc7ec9982017-05-23 23:00:52 -0700892/* Update interpreter state based on supplied configuration settings
893 *
894 * After calling this function, most of the restrictions on the interpreter
895 * are lifted. The only remaining incomplete settings are those related
896 * to the main module (sys.argv[0], __main__ metadata)
897 *
898 * Calling this when the interpreter is not initializing, is already
899 * initialized or without a valid current thread state is a fatal error.
900 * Other errors should be reported as normal Python exceptions with a
901 * non-zero return code.
902 */
Victor Stinner5ac27a52019-03-27 13:40:14 +0100903static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200904_Py_InitializeMainInterpreter(_PyRuntimeState *runtime,
905 PyInterpreterState *interp)
Eric Snow1abcf672017-05-23 21:46:51 -0700906{
Victor Stinner43125222019-04-24 18:23:53 +0200907 if (!runtime->core_initialized) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800908 return _Py_INIT_ERR("runtime core not initialized");
Eric Snowc7ec9982017-05-23 23:00:52 -0700909 }
Eric Snowc7ec9982017-05-23 23:00:52 -0700910
Victor Stinner1dc6e392018-07-25 02:49:17 +0200911 /* Configure the main interpreter */
Victor Stinner1dc6e392018-07-25 02:49:17 +0200912 _PyCoreConfig *core_config = &interp->core_config;
Eric Snowc7ec9982017-05-23 23:00:52 -0700913
Victor Stinner43125222019-04-24 18:23:53 +0200914 if (runtime->initialized) {
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100915 return _Py_ReconfigureMainInterpreter(interp);
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200916 }
917
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200918 if (!core_config->_install_importlib) {
Eric Snow1abcf672017-05-23 21:46:51 -0700919 /* Special mode for freeze_importlib: run with no import system
920 *
921 * This means anything which needs support from extension modules
922 * or pure Python code in the standard library won't work.
923 */
Victor Stinner43125222019-04-24 18:23:53 +0200924 runtime->initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800925 return _Py_INIT_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700926 }
Victor Stinner9316ee42017-11-25 03:17:57 +0100927
Victor Stinner33c377e2017-12-05 15:12:41 +0100928 if (_PyTime_Init() < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800929 return _Py_INIT_ERR("can't initialize time");
Victor Stinner33c377e2017-12-05 15:12:41 +0100930 }
Victor Stinner13019fd2015-04-03 13:10:54 +0200931
Victor Stinner43125222019-04-24 18:23:53 +0200932 if (_PySys_InitMain(runtime, interp) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800933 return _Py_INIT_ERR("can't finish initializing sys");
Victor Stinnerda273412017-12-15 01:46:02 +0100934 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800935
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400936 _PyInitError err = init_importlib_external(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800937 if (_Py_INIT_FAILED(err)) {
938 return err;
939 }
Nick Coghland6009512014-11-20 21:39:37 +1000940
941 /* initialize the faulthandler module */
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200942 err = _PyFaulthandler_Init(core_config->faulthandler);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800943 if (_Py_INIT_FAILED(err)) {
944 return err;
945 }
Nick Coghland6009512014-11-20 21:39:37 +1000946
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400947 err = _PyUnicode_InitEncodings(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800948 if (_Py_INIT_FAILED(err)) {
949 return err;
950 }
Nick Coghland6009512014-11-20 21:39:37 +1000951
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100952 if (core_config->install_signal_handlers) {
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400953 err = init_signals();
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800954 if (_Py_INIT_FAILED(err)) {
955 return err;
956 }
957 }
Nick Coghland6009512014-11-20 21:39:37 +1000958
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200959 if (_PyTraceMalloc_Init(core_config->tracemalloc) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800960 return _Py_INIT_ERR("can't initialize tracemalloc");
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200961 }
Nick Coghland6009512014-11-20 21:39:37 +1000962
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800963 err = add_main_module(interp);
964 if (_Py_INIT_FAILED(err)) {
965 return err;
966 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800967
Victor Stinner91106cd2017-12-13 12:29:09 +0100968 err = init_sys_streams(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -0800969 if (_Py_INIT_FAILED(err)) {
970 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800971 }
Nick Coghland6009512014-11-20 21:39:37 +1000972
973 /* Initialize warnings. */
Victor Stinner37cd9822018-11-16 11:55:35 +0100974 PyObject *warnoptions = PySys_GetObject("warnoptions");
975 if (warnoptions != NULL && PyList_Size(warnoptions) > 0)
Victor Stinner5d862462017-12-19 11:35:58 +0100976 {
Nick Coghland6009512014-11-20 21:39:37 +1000977 PyObject *warnings_module = PyImport_ImportModule("warnings");
978 if (warnings_module == NULL) {
979 fprintf(stderr, "'import warnings' failed; traceback:\n");
980 PyErr_Print();
981 }
982 Py_XDECREF(warnings_module);
983 }
984
Victor Stinner43125222019-04-24 18:23:53 +0200985 runtime->initialized = 1;
Eric Snow1abcf672017-05-23 21:46:51 -0700986
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200987 if (core_config->site_import) {
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400988 err = init_import_size(); /* Module site */
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800989 if (_Py_INIT_FAILED(err)) {
990 return err;
991 }
992 }
Victor Stinnercf215042018-08-29 22:56:06 +0200993
994#ifndef MS_WINDOWS
Victor Stinner43125222019-04-24 18:23:53 +0200995 emit_stderr_warning_for_legacy_locale(runtime);
Victor Stinnercf215042018-08-29 22:56:06 +0200996#endif
997
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800998 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000999}
1000
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001001
1002_PyInitError
1003_Py_InitializeMain(void)
1004{
1005 _PyInitError err = _PyRuntime_Initialize();
1006 if (_Py_INIT_FAILED(err)) {
1007 return err;
1008 }
1009 _PyRuntimeState *runtime = &_PyRuntime;
1010 PyInterpreterState *interp = _PyRuntimeState_GetThreadState(runtime)->interp;
1011
1012 return _Py_InitializeMainInterpreter(runtime, interp);
1013}
1014
1015
Eric Snowc7ec9982017-05-23 23:00:52 -07001016#undef _INIT_DEBUG_PRINT
1017
Victor Stinner5ac27a52019-03-27 13:40:14 +01001018static _PyInitError
1019init_python(const _PyCoreConfig *config, const _PyArgv *args)
Eric Snow1abcf672017-05-23 21:46:51 -07001020{
Victor Stinner6d1c4672019-05-20 11:02:00 +02001021 if (config == NULL) {
1022 return _Py_INIT_ERR("initialization config is NULL");
1023 }
1024
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001025 _PyInitError err;
Victor Stinner43125222019-04-24 18:23:53 +02001026
1027 err = _PyRuntime_Initialize();
1028 if (_Py_INIT_FAILED(err)) {
1029 return err;
1030 }
1031 _PyRuntimeState *runtime = &_PyRuntime;
1032
1033 PyInterpreterState *interp = NULL;
1034 err = _Py_InitializeCore(runtime, config, args, &interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001035 if (_Py_INIT_FAILED(err)) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001036 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001037 }
Victor Stinner1dc6e392018-07-25 02:49:17 +02001038 config = &interp->core_config;
Victor Stinnerbc8ac6b2017-11-30 18:03:55 +01001039
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001040 if (config->_init_main) {
Victor Stinner43125222019-04-24 18:23:53 +02001041 err = _Py_InitializeMainInterpreter(runtime, interp);
Victor Stinner484f20d2019-03-27 02:04:16 +01001042 if (_Py_INIT_FAILED(err)) {
1043 return err;
1044 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001045 }
Victor Stinner484f20d2019-03-27 02:04:16 +01001046
Victor Stinner1dc6e392018-07-25 02:49:17 +02001047 return _Py_INIT_OK();
Eric Snow1abcf672017-05-23 21:46:51 -07001048}
1049
1050
Victor Stinner5ac27a52019-03-27 13:40:14 +01001051_PyInitError
Victor Stinner6d1c4672019-05-20 11:02:00 +02001052_Py_InitializeFromArgs(const _PyCoreConfig *config,
1053 Py_ssize_t argc, char * const *argv)
Victor Stinner5ac27a52019-03-27 13:40:14 +01001054{
1055 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
1056 return init_python(config, &args);
1057}
1058
1059
1060_PyInitError
Victor Stinner6d1c4672019-05-20 11:02:00 +02001061_Py_InitializeFromWideArgs(const _PyCoreConfig *config,
1062 Py_ssize_t argc, wchar_t * const *argv)
Victor Stinner5ac27a52019-03-27 13:40:14 +01001063{
1064 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
1065 return init_python(config, &args);
1066}
1067
1068
1069_PyInitError
1070_Py_InitializeFromConfig(const _PyCoreConfig *config)
1071{
1072 return init_python(config, NULL);
1073}
1074
1075
Eric Snow1abcf672017-05-23 21:46:51 -07001076void
Nick Coghland6009512014-11-20 21:39:37 +10001077Py_InitializeEx(int install_sigs)
1078{
Victor Stinner43125222019-04-24 18:23:53 +02001079 _PyInitError err;
1080
1081 err = _PyRuntime_Initialize();
1082 if (_Py_INIT_FAILED(err)) {
1083 _Py_ExitInitError(err);
1084 }
1085 _PyRuntimeState *runtime = &_PyRuntime;
1086
1087 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001088 /* bpo-33932: Calling Py_Initialize() twice does nothing. */
1089 return;
1090 }
1091
Victor Stinnercab5d072019-05-17 19:01:14 +02001092 _PyCoreConfig config;
1093 _PyCoreConfig_Init(&config);
Victor Stinner1dc6e392018-07-25 02:49:17 +02001094 config.install_signal_handlers = install_sigs;
1095
Victor Stinner43125222019-04-24 18:23:53 +02001096 err = _Py_InitializeFromConfig(&config);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001097 if (_Py_INIT_FAILED(err)) {
Victor Stinnerdfe88472019-03-01 12:14:41 +01001098 _Py_ExitInitError(err);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001099 }
Nick Coghland6009512014-11-20 21:39:37 +10001100}
1101
1102void
1103Py_Initialize(void)
1104{
1105 Py_InitializeEx(1);
1106}
1107
1108
1109#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001110extern void _Py_dump_counts(FILE*);
Nick Coghland6009512014-11-20 21:39:37 +10001111#endif
1112
1113/* Flush stdout and stderr */
1114
1115static int
1116file_is_closed(PyObject *fobj)
1117{
1118 int r;
1119 PyObject *tmp = PyObject_GetAttrString(fobj, "closed");
1120 if (tmp == NULL) {
1121 PyErr_Clear();
1122 return 0;
1123 }
1124 r = PyObject_IsTrue(tmp);
1125 Py_DECREF(tmp);
1126 if (r < 0)
1127 PyErr_Clear();
1128 return r > 0;
1129}
1130
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001131static int
Nick Coghland6009512014-11-20 21:39:37 +10001132flush_std_files(void)
1133{
1134 PyObject *fout = _PySys_GetObjectId(&PyId_stdout);
1135 PyObject *ferr = _PySys_GetObjectId(&PyId_stderr);
1136 PyObject *tmp;
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001137 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001138
1139 if (fout != NULL && fout != Py_None && !file_is_closed(fout)) {
Victor Stinner3466bde2016-09-05 18:16:01 -07001140 tmp = _PyObject_CallMethodId(fout, &PyId_flush, NULL);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001141 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001142 PyErr_WriteUnraisable(fout);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001143 status = -1;
1144 }
Nick Coghland6009512014-11-20 21:39:37 +10001145 else
1146 Py_DECREF(tmp);
1147 }
1148
1149 if (ferr != NULL && ferr != Py_None && !file_is_closed(ferr)) {
Victor Stinner3466bde2016-09-05 18:16:01 -07001150 tmp = _PyObject_CallMethodId(ferr, &PyId_flush, NULL);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001151 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001152 PyErr_Clear();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001153 status = -1;
1154 }
Nick Coghland6009512014-11-20 21:39:37 +10001155 else
1156 Py_DECREF(tmp);
1157 }
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001158
1159 return status;
Nick Coghland6009512014-11-20 21:39:37 +10001160}
1161
1162/* Undo the effect of Py_Initialize().
1163
1164 Beware: if multiple interpreter and/or thread states exist, these
1165 are not wiped out; only the current thread and interpreter state
1166 are deleted. But since everything else is deleted, those other
1167 interpreter and thread states should no longer be used.
1168
1169 (XXX We should do better, e.g. wipe out all interpreters and
1170 threads.)
1171
1172 Locking: as above.
1173
1174*/
1175
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001176int
1177Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001178{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001179 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001180
Victor Stinner8e91c242019-04-24 17:24:01 +02001181 _PyRuntimeState *runtime = &_PyRuntime;
1182 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001183 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001184 }
Nick Coghland6009512014-11-20 21:39:37 +10001185
Eric Snow842a2f02019-03-15 15:47:51 -06001186 // Wrap up existing "threading"-module-created, non-daemon threads.
Nick Coghland6009512014-11-20 21:39:37 +10001187 wait_for_thread_shutdown();
1188
Eric Snow842a2f02019-03-15 15:47:51 -06001189 // Make any remaining pending calls.
Victor Stinner09532fe2019-05-10 23:39:09 +02001190 _Py_FinishPendingCalls(runtime);
Eric Snow842a2f02019-03-15 15:47:51 -06001191
Victor Stinner8e91c242019-04-24 17:24:01 +02001192 /* Get current thread state and interpreter pointer */
Victor Stinner09532fe2019-05-10 23:39:09 +02001193 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
Victor Stinner8e91c242019-04-24 17:24:01 +02001194 PyInterpreterState *interp = tstate->interp;
1195
Nick Coghland6009512014-11-20 21:39:37 +10001196 /* The interpreter is still entirely intact at this point, and the
1197 * exit funcs may be relying on that. In particular, if some thread
1198 * or exit func is still waiting to do an import, the import machinery
1199 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001200 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001201 * Note that Threading.py uses an exit func to do a join on all the
1202 * threads created thru it, so this also protects pending imports in
1203 * the threads created via Threading.
1204 */
Nick Coghland6009512014-11-20 21:39:37 +10001205
Marcel Plch776407f2017-12-20 11:17:58 +01001206 call_py_exitfuncs(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001207
Victor Stinnerda273412017-12-15 01:46:02 +01001208 /* Copy the core config, PyInterpreterState_Delete() free
1209 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001210#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001211 int show_ref_count = interp->core_config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001212#endif
1213#ifdef Py_TRACE_REFS
Victor Stinnerda273412017-12-15 01:46:02 +01001214 int dump_refs = interp->core_config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001215#endif
1216#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001217 int malloc_stats = interp->core_config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001218#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001219
Nick Coghland6009512014-11-20 21:39:37 +10001220 /* Remaining threads (e.g. daemon threads) will automatically exit
1221 after taking the GIL (in PyEval_RestoreThread()). */
Victor Stinner8e91c242019-04-24 17:24:01 +02001222 runtime->finalizing = tstate;
1223 runtime->initialized = 0;
1224 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001225
Victor Stinnere0deff32015-03-24 13:46:18 +01001226 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001227 if (flush_std_files() < 0) {
1228 status = -1;
1229 }
Nick Coghland6009512014-11-20 21:39:37 +10001230
1231 /* Disable signal handling */
1232 PyOS_FiniInterrupts();
1233
1234 /* Collect garbage. This may call finalizers; it's nice to call these
1235 * before all modules are destroyed.
1236 * XXX If a __del__ or weakref callback is triggered here, and tries to
1237 * XXX import a module, bad things can happen, because Python no
1238 * XXX longer believes it's initialized.
1239 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1240 * XXX is easy to provoke that way. I've also seen, e.g.,
1241 * XXX Exception exceptions.ImportError: 'No module named sha'
1242 * XXX in <function callback at 0x008F5718> ignored
1243 * XXX but I'm unclear on exactly how that one happens. In any case,
1244 * XXX I haven't seen a real-life report of either of these.
1245 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001246 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001247#ifdef COUNT_ALLOCS
1248 /* With COUNT_ALLOCS, it helps to run GC multiple times:
1249 each collection might release some types from the type
1250 list, so they become garbage. */
Łukasz Langafef7e942016-09-09 21:47:46 -07001251 while (_PyGC_CollectIfEnabled() > 0)
Nick Coghland6009512014-11-20 21:39:37 +10001252 /* nothing */;
1253#endif
Eric Snowdae02762017-09-14 00:35:58 -07001254
Nick Coghland6009512014-11-20 21:39:37 +10001255 /* Destroy all modules */
1256 PyImport_Cleanup();
1257
Victor Stinnere0deff32015-03-24 13:46:18 +01001258 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001259 if (flush_std_files() < 0) {
1260 status = -1;
1261 }
Nick Coghland6009512014-11-20 21:39:37 +10001262
1263 /* Collect final garbage. This disposes of cycles created by
1264 * class definitions, for example.
1265 * XXX This is disabled because it caused too many problems. If
1266 * XXX a __del__ or weakref callback triggers here, Python code has
1267 * XXX a hard time running, because even the sys module has been
1268 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1269 * XXX One symptom is a sequence of information-free messages
1270 * XXX coming from threads (if a __del__ or callback is invoked,
1271 * XXX other threads can execute too, and any exception they encounter
1272 * XXX triggers a comedy of errors as subsystem after subsystem
1273 * XXX fails to find what it *expects* to find in sys to help report
1274 * XXX the exception and consequent unexpected failures). I've also
1275 * XXX seen segfaults then, after adding print statements to the
1276 * XXX Python code getting called.
1277 */
1278#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001279 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001280#endif
1281
1282 /* Disable tracemalloc after all Python objects have been destroyed,
1283 so it is possible to use tracemalloc in objects destructor. */
1284 _PyTraceMalloc_Fini();
1285
1286 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1287 _PyImport_Fini();
1288
1289 /* Cleanup typeobject.c's internal caches. */
1290 _PyType_Fini();
1291
1292 /* unload faulthandler module */
1293 _PyFaulthandler_Fini();
1294
1295 /* Debugging stuff */
1296#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001297 _Py_dump_counts(stderr);
Nick Coghland6009512014-11-20 21:39:37 +10001298#endif
1299 /* dump hash stats */
1300 _PyHash_Fini();
1301
Eric Snowdae02762017-09-14 00:35:58 -07001302#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001303 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001304 _PyDebug_PrintTotalRefs();
1305 }
Eric Snowdae02762017-09-14 00:35:58 -07001306#endif
Nick Coghland6009512014-11-20 21:39:37 +10001307
1308#ifdef Py_TRACE_REFS
1309 /* Display all objects still alive -- this can invoke arbitrary
1310 * __repr__ overrides, so requires a mostly-intact interpreter.
1311 * Alas, a lot of stuff may still be alive now that will be cleaned
1312 * up later.
1313 */
Victor Stinnerda273412017-12-15 01:46:02 +01001314 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001315 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001316 }
Nick Coghland6009512014-11-20 21:39:37 +10001317#endif /* Py_TRACE_REFS */
1318
1319 /* Clear interpreter state and all thread states. */
1320 PyInterpreterState_Clear(interp);
1321
1322 /* Now we decref the exception classes. After this point nothing
1323 can raise an exception. That's okay, because each Fini() method
1324 below has been checked to make sure no exceptions are ever
1325 raised.
1326 */
1327
1328 _PyExc_Fini();
1329
1330 /* Sundry finalizers */
1331 PyMethod_Fini();
1332 PyFrame_Fini();
1333 PyCFunction_Fini();
1334 PyTuple_Fini();
1335 PyList_Fini();
1336 PySet_Fini();
1337 PyBytes_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001338 PyLong_Fini();
1339 PyFloat_Fini();
1340 PyDict_Fini();
1341 PySlice_Fini();
Victor Stinner8e91c242019-04-24 17:24:01 +02001342 _PyGC_Fini(runtime);
Eric Snow86ea5812019-05-10 13:29:55 -04001343 _PyWarnings_Fini(interp);
Eric Snow6b4be192017-05-22 21:36:03 -07001344 _Py_HashRandomization_Fini();
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001345 _PyArg_Fini();
Yury Selivanoveb636452016-09-08 22:01:51 -07001346 PyAsyncGen_Fini();
Yury Selivanovf23746a2018-01-22 19:11:18 -05001347 _PyContext_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001348
1349 /* Cleanup Unicode implementation */
1350 _PyUnicode_Fini();
1351
Victor Stinnerb2457ef2018-08-29 13:25:36 +02001352 _Py_ClearFileSystemEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10001353
1354 /* XXX Still allocated:
1355 - various static ad-hoc pointers to interned strings
1356 - int and float free list blocks
1357 - whatever various modules and libraries allocate
1358 */
1359
1360 PyGrammar_RemoveAccelerators(&_PyParser_Grammar);
1361
1362 /* Cleanup auto-thread-state */
Victor Stinner8e91c242019-04-24 17:24:01 +02001363 _PyGILState_Fini(runtime);
Nick Coghland6009512014-11-20 21:39:37 +10001364
1365 /* Delete current thread. After this, many C API calls become crashy. */
1366 PyThreadState_Swap(NULL);
Victor Stinner8a1be612016-03-14 22:07:55 +01001367
Nick Coghland6009512014-11-20 21:39:37 +10001368 PyInterpreterState_Delete(interp);
1369
1370#ifdef Py_TRACE_REFS
1371 /* Display addresses (& refcnts) of all objects still alive.
1372 * An address can be used to find the repr of the object, printed
1373 * above by _Py_PrintReferences.
1374 */
Victor Stinnerda273412017-12-15 01:46:02 +01001375 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001376 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001377 }
Nick Coghland6009512014-11-20 21:39:37 +10001378#endif /* Py_TRACE_REFS */
Victor Stinner34be8072016-03-14 12:04:26 +01001379#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001380 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001381 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be8072016-03-14 12:04:26 +01001382 }
Nick Coghland6009512014-11-20 21:39:37 +10001383#endif
1384
Victor Stinner8e91c242019-04-24 17:24:01 +02001385 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001386
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001387 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001388 return status;
1389}
1390
1391void
1392Py_Finalize(void)
1393{
1394 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001395}
1396
1397/* Create and initialize a new interpreter and thread, and return the
1398 new thread. This requires that Py_Initialize() has been called
1399 first.
1400
1401 Unsuccessful initialization yields a NULL pointer. Note that *no*
1402 exception information is available even in this case -- the
1403 exception information is held in the thread, and there is no
1404 thread.
1405
1406 Locking: as above.
1407
1408*/
1409
Victor Stinnera7368ac2017-11-15 18:11:45 -08001410static _PyInitError
1411new_interpreter(PyThreadState **tstate_p)
Nick Coghland6009512014-11-20 21:39:37 +10001412{
Victor Stinner9316ee42017-11-25 03:17:57 +01001413 _PyInitError err;
Nick Coghland6009512014-11-20 21:39:37 +10001414
Victor Stinner43125222019-04-24 18:23:53 +02001415 err = _PyRuntime_Initialize();
1416 if (_Py_INIT_FAILED(err)) {
1417 return err;
1418 }
1419 _PyRuntimeState *runtime = &_PyRuntime;
1420
1421 if (!runtime->initialized) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001422 return _Py_INIT_ERR("Py_Initialize must be called first");
1423 }
Nick Coghland6009512014-11-20 21:39:37 +10001424
Victor Stinner8a1be612016-03-14 22:07:55 +01001425 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1426 interpreters: disable PyGILState_Check(). */
1427 _PyGILState_check_enabled = 0;
1428
Victor Stinner43125222019-04-24 18:23:53 +02001429 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001430 if (interp == NULL) {
1431 *tstate_p = NULL;
1432 return _Py_INIT_OK();
1433 }
Nick Coghland6009512014-11-20 21:39:37 +10001434
Victor Stinner43125222019-04-24 18:23:53 +02001435 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001436 if (tstate == NULL) {
1437 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001438 *tstate_p = NULL;
1439 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001440 }
1441
Victor Stinner43125222019-04-24 18:23:53 +02001442 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001443
Eric Snow1abcf672017-05-23 21:46:51 -07001444 /* Copy the current interpreter config into the new interpreter */
Victor Stinnerda273412017-12-15 01:46:02 +01001445 _PyCoreConfig *core_config;
Eric Snow1abcf672017-05-23 21:46:51 -07001446 if (save_tstate != NULL) {
Victor Stinnerda273412017-12-15 01:46:02 +01001447 core_config = &save_tstate->interp->core_config;
Eric Snow1abcf672017-05-23 21:46:51 -07001448 } else {
1449 /* No current thread state, copy from the main interpreter */
1450 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinnerda273412017-12-15 01:46:02 +01001451 core_config = &main_interp->core_config;
Victor Stinnerda273412017-12-15 01:46:02 +01001452 }
1453
Victor Stinner1a9f0d82019-05-01 15:22:52 +02001454 err = _PyCoreConfig_Copy(&interp->core_config, core_config);
1455 if (_Py_INIT_FAILED(err)) {
1456 return err;
Victor Stinnerda273412017-12-15 01:46:02 +01001457 }
Victor Stinnerd19d8d52018-07-24 13:55:48 +02001458 core_config = &interp->core_config;
Eric Snow1abcf672017-05-23 21:46:51 -07001459
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001460 err = _PyExc_Init();
1461 if (_Py_INIT_FAILED(err)) {
1462 return err;
1463 }
1464
Nick Coghland6009512014-11-20 21:39:37 +10001465 /* XXX The following is lax in error checking */
Eric Snowd393c1b2017-09-14 12:18:12 -06001466 PyObject *modules = PyDict_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001467 if (modules == NULL) {
1468 return _Py_INIT_ERR("can't make modules dictionary");
1469 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001470 interp->modules = modules;
Nick Coghland6009512014-11-20 21:39:37 +10001471
Victor Stinner43125222019-04-24 18:23:53 +02001472 PyObject *sysmod = _PyImport_FindBuiltin("sys", modules);
Eric Snowd393c1b2017-09-14 12:18:12 -06001473 if (sysmod != NULL) {
1474 interp->sysdict = PyModule_GetDict(sysmod);
Victor Stinner43125222019-04-24 18:23:53 +02001475 if (interp->sysdict == NULL) {
Eric Snowd393c1b2017-09-14 12:18:12 -06001476 goto handle_error;
Victor Stinner43125222019-04-24 18:23:53 +02001477 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001478 Py_INCREF(interp->sysdict);
1479 PyDict_SetItemString(interp->sysdict, "modules", modules);
Victor Stinner43125222019-04-24 18:23:53 +02001480 if (_PySys_InitMain(runtime, interp) < 0) {
Victor Stinnerab672812019-01-23 15:04:40 +01001481 return _Py_INIT_ERR("can't finish initializing sys");
1482 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001483 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001484 else if (PyErr_Occurred()) {
1485 goto handle_error;
1486 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001487
Victor Stinner43125222019-04-24 18:23:53 +02001488 PyObject *bimod = _PyImport_FindBuiltin("builtins", modules);
Nick Coghland6009512014-11-20 21:39:37 +10001489 if (bimod != NULL) {
1490 interp->builtins = PyModule_GetDict(bimod);
1491 if (interp->builtins == NULL)
1492 goto handle_error;
1493 Py_INCREF(interp->builtins);
1494 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001495 else if (PyErr_Occurred()) {
1496 goto handle_error;
1497 }
Nick Coghland6009512014-11-20 21:39:37 +10001498
Nick Coghland6009512014-11-20 21:39:37 +10001499 if (bimod != NULL && sysmod != NULL) {
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001500 err = _PyBuiltins_AddExceptions(bimod);
1501 if (_Py_INIT_FAILED(err)) {
1502 return err;
1503 }
Nick Coghland6009512014-11-20 21:39:37 +10001504
Victor Stinnerab672812019-01-23 15:04:40 +01001505 err = _PySys_SetPreliminaryStderr(interp->sysdict);
1506 if (_Py_INIT_FAILED(err)) {
1507 return err;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001508 }
Nick Coghland6009512014-11-20 21:39:37 +10001509
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001510 err = _PyImportHooks_Init();
1511 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001512 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001513 }
Nick Coghland6009512014-11-20 21:39:37 +10001514
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001515 err = init_importlib(interp, sysmod);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001516 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001517 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001518 }
Nick Coghland6009512014-11-20 21:39:37 +10001519
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001520 err = init_importlib_external(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001521 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001522 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001523 }
Nick Coghland6009512014-11-20 21:39:37 +10001524
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001525 err = _PyUnicode_InitEncodings(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001526 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001527 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001528 }
1529
Victor Stinner91106cd2017-12-13 12:29:09 +01001530 err = init_sys_streams(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001531 if (_Py_INIT_FAILED(err)) {
1532 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001533 }
1534
1535 err = add_main_module(interp);
1536 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001537 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001538 }
1539
Victor Stinnerd19d8d52018-07-24 13:55:48 +02001540 if (core_config->site_import) {
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001541 err = init_import_size();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001542 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001543 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001544 }
1545 }
Nick Coghland6009512014-11-20 21:39:37 +10001546 }
1547
Victor Stinnera7368ac2017-11-15 18:11:45 -08001548 if (PyErr_Occurred()) {
1549 goto handle_error;
1550 }
Nick Coghland6009512014-11-20 21:39:37 +10001551
Victor Stinnera7368ac2017-11-15 18:11:45 -08001552 *tstate_p = tstate;
1553 return _Py_INIT_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001554
Nick Coghland6009512014-11-20 21:39:37 +10001555handle_error:
1556 /* Oops, it didn't work. Undo it all. */
1557
1558 PyErr_PrintEx(0);
1559 PyThreadState_Clear(tstate);
1560 PyThreadState_Swap(save_tstate);
1561 PyThreadState_Delete(tstate);
1562 PyInterpreterState_Delete(interp);
1563
Victor Stinnera7368ac2017-11-15 18:11:45 -08001564 *tstate_p = NULL;
1565 return _Py_INIT_OK();
1566}
1567
1568PyThreadState *
1569Py_NewInterpreter(void)
1570{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001571 PyThreadState *tstate = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001572 _PyInitError err = new_interpreter(&tstate);
1573 if (_Py_INIT_FAILED(err)) {
Victor Stinnerdfe88472019-03-01 12:14:41 +01001574 _Py_ExitInitError(err);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001575 }
1576 return tstate;
1577
Nick Coghland6009512014-11-20 21:39:37 +10001578}
1579
1580/* Delete an interpreter and its last thread. This requires that the
1581 given thread state is current, that the thread has no remaining
1582 frames, and that it is its interpreter's only remaining thread.
1583 It is a fatal error to violate these constraints.
1584
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001585 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001586 everything, regardless.)
1587
1588 Locking: as above.
1589
1590*/
1591
1592void
1593Py_EndInterpreter(PyThreadState *tstate)
1594{
1595 PyInterpreterState *interp = tstate->interp;
1596
Victor Stinner50b48572018-11-01 01:51:40 +01001597 if (tstate != _PyThreadState_GET())
Nick Coghland6009512014-11-20 21:39:37 +10001598 Py_FatalError("Py_EndInterpreter: thread is not current");
1599 if (tstate->frame != NULL)
1600 Py_FatalError("Py_EndInterpreter: thread still has a frame");
Eric Snow5be45a62019-03-08 22:47:07 -07001601 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001602
Eric Snow842a2f02019-03-15 15:47:51 -06001603 // Wrap up existing "threading"-module-created, non-daemon threads.
Nick Coghland6009512014-11-20 21:39:37 +10001604 wait_for_thread_shutdown();
1605
Marcel Plch776407f2017-12-20 11:17:58 +01001606 call_py_exitfuncs(interp);
1607
Nick Coghland6009512014-11-20 21:39:37 +10001608 if (tstate != interp->tstate_head || tstate->next != NULL)
1609 Py_FatalError("Py_EndInterpreter: not the last thread");
1610
1611 PyImport_Cleanup();
1612 PyInterpreterState_Clear(interp);
1613 PyThreadState_Swap(NULL);
1614 PyInterpreterState_Delete(interp);
1615}
1616
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001617/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001618
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001619static _PyInitError
1620add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001621{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001622 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001623 m = PyImport_AddModule("__main__");
1624 if (m == NULL)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001625 return _Py_INIT_ERR("can't create __main__ module");
1626
Nick Coghland6009512014-11-20 21:39:37 +10001627 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001628 ann_dict = PyDict_New();
1629 if ((ann_dict == NULL) ||
1630 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001631 return _Py_INIT_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001632 }
1633 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001634
Nick Coghland6009512014-11-20 21:39:37 +10001635 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1636 PyObject *bimod = PyImport_ImportModule("builtins");
1637 if (bimod == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001638 return _Py_INIT_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001639 }
1640 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001641 return _Py_INIT_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001642 }
1643 Py_DECREF(bimod);
1644 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001645
Nick Coghland6009512014-11-20 21:39:37 +10001646 /* Main is a little special - imp.is_builtin("__main__") will return
1647 * False, but BuiltinImporter is still the most appropriate initial
1648 * setting for its __loader__ attribute. A more suitable value will
1649 * be set if __main__ gets further initialized later in the startup
1650 * process.
1651 */
1652 loader = PyDict_GetItemString(d, "__loader__");
1653 if (loader == NULL || loader == Py_None) {
1654 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1655 "BuiltinImporter");
1656 if (loader == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001657 return _Py_INIT_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001658 }
1659 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001660 return _Py_INIT_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001661 }
1662 Py_DECREF(loader);
1663 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001664 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001665}
1666
Nick Coghland6009512014-11-20 21:39:37 +10001667/* Import the site module (not into __main__ though) */
1668
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001669static _PyInitError
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001670init_import_size(void)
Nick Coghland6009512014-11-20 21:39:37 +10001671{
1672 PyObject *m;
1673 m = PyImport_ImportModule("site");
1674 if (m == NULL) {
Victor Stinnerdb719752019-05-01 05:35:33 +02001675 return _Py_INIT_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001676 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001677 Py_DECREF(m);
1678 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001679}
1680
Victor Stinner874dbe82015-09-04 17:29:57 +02001681/* Check if a file descriptor is valid or not.
1682 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1683static int
1684is_valid_fd(int fd)
1685{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001686/* dup() is faster than fstat(): fstat() can require input/output operations,
1687 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1688 startup. Problem: dup() doesn't check if the file descriptor is valid on
1689 some platforms.
1690
1691 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1692 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1693 EBADF. FreeBSD has similar issue (bpo-32849).
1694
1695 Only use dup() on platforms where dup() is enough to detect invalid FD in
1696 corner cases: on Linux and Windows (bpo-32849). */
1697#if defined(__linux__) || defined(MS_WINDOWS)
1698 if (fd < 0) {
1699 return 0;
1700 }
1701 int fd2;
1702
1703 _Py_BEGIN_SUPPRESS_IPH
1704 fd2 = dup(fd);
1705 if (fd2 >= 0) {
1706 close(fd2);
1707 }
1708 _Py_END_SUPPRESS_IPH
1709
1710 return (fd2 >= 0);
1711#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001712 struct stat st;
1713 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001714#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001715}
1716
1717/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001718static PyObject*
Victor Stinnerfbca9082018-08-30 00:50:45 +02001719create_stdio(const _PyCoreConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001720 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001721 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001722{
1723 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1724 const char* mode;
1725 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001726 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001727 int buffering, isatty;
1728 _Py_IDENTIFIER(open);
1729 _Py_IDENTIFIER(isatty);
1730 _Py_IDENTIFIER(TextIOWrapper);
1731 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001732 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001733
Victor Stinner874dbe82015-09-04 17:29:57 +02001734 if (!is_valid_fd(fd))
1735 Py_RETURN_NONE;
1736
Nick Coghland6009512014-11-20 21:39:37 +10001737 /* stdin is always opened in buffered mode, first because it shouldn't
1738 make a difference in common use cases, second because TextIOWrapper
1739 depends on the presence of a read1() method which only exists on
1740 buffered streams.
1741 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001742 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001743 buffering = 0;
1744 else
1745 buffering = -1;
1746 if (write_mode)
1747 mode = "wb";
1748 else
1749 mode = "rb";
1750 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOi",
1751 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001752 Py_None, Py_None, /* encoding, errors */
1753 Py_None, 0); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001754 if (buf == NULL)
1755 goto error;
1756
1757 if (buffering) {
1758 _Py_IDENTIFIER(raw);
1759 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1760 if (raw == NULL)
1761 goto error;
1762 }
1763 else {
1764 raw = buf;
1765 Py_INCREF(raw);
1766 }
1767
Steve Dower39294992016-08-30 21:22:36 -07001768#ifdef MS_WINDOWS
1769 /* Windows console IO is always UTF-8 encoded */
1770 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001771 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001772#endif
1773
Nick Coghland6009512014-11-20 21:39:37 +10001774 text = PyUnicode_FromString(name);
1775 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1776 goto error;
Victor Stinner3466bde2016-09-05 18:16:01 -07001777 res = _PyObject_CallMethodId(raw, &PyId_isatty, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10001778 if (res == NULL)
1779 goto error;
1780 isatty = PyObject_IsTrue(res);
1781 Py_DECREF(res);
1782 if (isatty == -1)
1783 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001784 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001785 write_through = Py_True;
1786 else
1787 write_through = Py_False;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001788 if (isatty && buffered_stdio)
Nick Coghland6009512014-11-20 21:39:37 +10001789 line_buffering = Py_True;
1790 else
1791 line_buffering = Py_False;
1792
1793 Py_CLEAR(raw);
1794 Py_CLEAR(text);
1795
1796#ifdef MS_WINDOWS
1797 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1798 newlines to "\n".
1799 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1800 newline = NULL;
1801#else
1802 /* sys.stdin: split lines at "\n".
1803 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1804 newline = "\n";
1805#endif
1806
Victor Stinner709d23d2019-05-02 14:56:30 -04001807 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1808 if (encoding_str == NULL) {
1809 Py_CLEAR(buf);
1810 goto error;
1811 }
1812
1813 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1814 if (errors_str == NULL) {
1815 Py_CLEAR(buf);
1816 Py_CLEAR(encoding_str);
1817 goto error;
1818 }
1819
1820 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1821 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001822 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001823 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001824 Py_CLEAR(encoding_str);
1825 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001826 if (stream == NULL)
1827 goto error;
1828
1829 if (write_mode)
1830 mode = "w";
1831 else
1832 mode = "r";
1833 text = PyUnicode_FromString(mode);
1834 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1835 goto error;
1836 Py_CLEAR(text);
1837 return stream;
1838
1839error:
1840 Py_XDECREF(buf);
1841 Py_XDECREF(stream);
1842 Py_XDECREF(text);
1843 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001844
Victor Stinner874dbe82015-09-04 17:29:57 +02001845 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1846 /* Issue #24891: the file descriptor was closed after the first
1847 is_valid_fd() check was called. Ignore the OSError and set the
1848 stream to None. */
1849 PyErr_Clear();
1850 Py_RETURN_NONE;
1851 }
1852 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001853}
1854
1855/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinnera7368ac2017-11-15 18:11:45 -08001856static _PyInitError
Victor Stinner91106cd2017-12-13 12:29:09 +01001857init_sys_streams(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001858{
1859 PyObject *iomod = NULL, *wrapper;
1860 PyObject *bimod = NULL;
1861 PyObject *m;
1862 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001863 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001864 PyObject * encoding_attr;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001865 _PyInitError res = _Py_INIT_OK();
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001866 _PyCoreConfig *config = &interp->core_config;
1867
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001868 /* Check that stdin is not a directory
1869 Using shell redirection, you can redirect stdin to a directory,
1870 crashing the Python interpreter. Catch this common mistake here
1871 and output a useful error message. Note that under MS Windows,
1872 the shell already prevents that. */
1873#ifndef MS_WINDOWS
1874 struct _Py_stat_struct sb;
1875 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1876 S_ISDIR(sb.st_mode)) {
Victor Stinnerdb719752019-05-01 05:35:33 +02001877 return _Py_INIT_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001878 }
1879#endif
1880
Nick Coghland6009512014-11-20 21:39:37 +10001881 /* Hack to avoid a nasty recursion issue when Python is invoked
1882 in verbose mode: pre-import the Latin-1 and UTF-8 codecs */
1883 if ((m = PyImport_ImportModule("encodings.utf_8")) == NULL) {
1884 goto error;
1885 }
1886 Py_DECREF(m);
1887
1888 if (!(m = PyImport_ImportModule("encodings.latin_1"))) {
1889 goto error;
1890 }
1891 Py_DECREF(m);
1892
1893 if (!(bimod = PyImport_ImportModule("builtins"))) {
1894 goto error;
1895 }
1896
1897 if (!(iomod = PyImport_ImportModule("io"))) {
1898 goto error;
1899 }
1900 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1901 goto error;
1902 }
1903
1904 /* Set builtins.open */
1905 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1906 Py_DECREF(wrapper);
1907 goto error;
1908 }
1909 Py_DECREF(wrapper);
1910
Nick Coghland6009512014-11-20 21:39:37 +10001911 /* Set sys.stdin */
1912 fd = fileno(stdin);
1913 /* Under some conditions stdin, stdout and stderr may not be connected
1914 * and fileno() may point to an invalid file descriptor. For example
1915 * GUI apps don't have valid standard streams by default.
1916 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001917 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001918 config->stdio_encoding,
1919 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001920 if (std == NULL)
1921 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001922 PySys_SetObject("__stdin__", std);
1923 _PySys_SetObjectId(&PyId_stdin, std);
1924 Py_DECREF(std);
1925
1926 /* Set sys.stdout */
1927 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001928 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001929 config->stdio_encoding,
1930 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001931 if (std == NULL)
1932 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001933 PySys_SetObject("__stdout__", std);
1934 _PySys_SetObjectId(&PyId_stdout, std);
1935 Py_DECREF(std);
1936
1937#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
1938 /* Set sys.stderr, replaces the preliminary stderr */
1939 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001940 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001941 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04001942 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02001943 if (std == NULL)
1944 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001945
1946 /* Same as hack above, pre-import stderr's codec to avoid recursion
1947 when import.c tries to write to stderr in verbose mode. */
1948 encoding_attr = PyObject_GetAttrString(std, "encoding");
1949 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001950 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10001951 if (std_encoding != NULL) {
1952 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
1953 Py_XDECREF(codec_info);
1954 }
1955 Py_DECREF(encoding_attr);
1956 }
1957 PyErr_Clear(); /* Not a fatal error if codec isn't available */
1958
1959 if (PySys_SetObject("__stderr__", std) < 0) {
1960 Py_DECREF(std);
1961 goto error;
1962 }
1963 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
1964 Py_DECREF(std);
1965 goto error;
1966 }
1967 Py_DECREF(std);
1968#endif
1969
Victor Stinnera7368ac2017-11-15 18:11:45 -08001970 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10001971
Victor Stinnera7368ac2017-11-15 18:11:45 -08001972error:
1973 res = _Py_INIT_ERR("can't initialize sys standard streams");
1974
1975done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02001976 _Py_ClearStandardStreamEncoding();
Victor Stinner31e99082017-12-20 23:41:38 +01001977
Nick Coghland6009512014-11-20 21:39:37 +10001978 Py_XDECREF(bimod);
1979 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001980 return res;
Nick Coghland6009512014-11-20 21:39:37 +10001981}
1982
1983
Victor Stinner10dc4842015-03-24 12:01:30 +01001984static void
Victor Stinner791da1c2016-03-14 16:53:12 +01001985_Py_FatalError_DumpTracebacks(int fd)
Victor Stinner10dc4842015-03-24 12:01:30 +01001986{
Victor Stinner10dc4842015-03-24 12:01:30 +01001987 fputc('\n', stderr);
1988 fflush(stderr);
1989
1990 /* display the current Python stack */
Victor Stinner861d9ab2016-03-16 22:45:24 +01001991 _Py_DumpTracebackThreads(fd, NULL, NULL);
Victor Stinner10dc4842015-03-24 12:01:30 +01001992}
Victor Stinner791da1c2016-03-14 16:53:12 +01001993
1994/* Print the current exception (if an exception is set) with its traceback,
1995 or display the current Python stack.
1996
1997 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
1998 called on catastrophic cases.
1999
2000 Return 1 if the traceback was displayed, 0 otherwise. */
2001
2002static int
2003_Py_FatalError_PrintExc(int fd)
2004{
2005 PyObject *ferr, *res;
2006 PyObject *exception, *v, *tb;
2007 int has_tb;
2008
Victor Stinner791da1c2016-03-14 16:53:12 +01002009 PyErr_Fetch(&exception, &v, &tb);
2010 if (exception == NULL) {
2011 /* No current exception */
2012 return 0;
2013 }
2014
2015 ferr = _PySys_GetObjectId(&PyId_stderr);
2016 if (ferr == NULL || ferr == Py_None) {
2017 /* sys.stderr is not set yet or set to None,
2018 no need to try to display the exception */
2019 return 0;
2020 }
2021
2022 PyErr_NormalizeException(&exception, &v, &tb);
2023 if (tb == NULL) {
2024 tb = Py_None;
2025 Py_INCREF(tb);
2026 }
2027 PyException_SetTraceback(v, tb);
2028 if (exception == NULL) {
2029 /* PyErr_NormalizeException() failed */
2030 return 0;
2031 }
2032
2033 has_tb = (tb != Py_None);
2034 PyErr_Display(exception, v, tb);
2035 Py_XDECREF(exception);
2036 Py_XDECREF(v);
2037 Py_XDECREF(tb);
2038
2039 /* sys.stderr may be buffered: call sys.stderr.flush() */
Victor Stinner3466bde2016-09-05 18:16:01 -07002040 res = _PyObject_CallMethodId(ferr, &PyId_flush, NULL);
Victor Stinner791da1c2016-03-14 16:53:12 +01002041 if (res == NULL)
2042 PyErr_Clear();
2043 else
2044 Py_DECREF(res);
2045
2046 return has_tb;
2047}
2048
Nick Coghland6009512014-11-20 21:39:37 +10002049/* Print fatal error message and abort */
2050
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002051#ifdef MS_WINDOWS
2052static void
2053fatal_output_debug(const char *msg)
2054{
2055 /* buffer of 256 bytes allocated on the stack */
2056 WCHAR buffer[256 / sizeof(WCHAR)];
2057 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2058 size_t msglen;
2059
2060 OutputDebugStringW(L"Fatal Python error: ");
2061
2062 msglen = strlen(msg);
2063 while (msglen) {
2064 size_t i;
2065
2066 if (buflen > msglen) {
2067 buflen = msglen;
2068 }
2069
2070 /* Convert the message to wchar_t. This uses a simple one-to-one
2071 conversion, assuming that the this error message actually uses
2072 ASCII only. If this ceases to be true, we will have to convert. */
2073 for (i=0; i < buflen; ++i) {
2074 buffer[i] = msg[i];
2075 }
2076 buffer[i] = L'\0';
2077 OutputDebugStringW(buffer);
2078
2079 msg += buflen;
2080 msglen -= buflen;
2081 }
2082 OutputDebugStringW(L"\n");
2083}
2084#endif
2085
Benjamin Petersoncef88b92017-11-25 13:02:55 -08002086static void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002087fatal_error(const char *prefix, const char *msg, int status)
Nick Coghland6009512014-11-20 21:39:37 +10002088{
2089 const int fd = fileno(stderr);
Victor Stinner53345a42015-03-25 01:55:14 +01002090 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002091
2092 if (reentrant) {
2093 /* Py_FatalError() caused a second fatal error.
2094 Example: flush_std_files() raises a recursion error. */
2095 goto exit;
2096 }
2097 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002098
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002099 fprintf(stderr, "Fatal Python error: ");
2100 if (prefix) {
2101 fputs(prefix, stderr);
2102 fputs(": ", stderr);
2103 }
2104 if (msg) {
2105 fputs(msg, stderr);
2106 }
2107 else {
2108 fprintf(stderr, "<message not set>");
2109 }
2110 fputs("\n", stderr);
Nick Coghland6009512014-11-20 21:39:37 +10002111 fflush(stderr); /* it helps in Windows debug build */
Victor Stinner10dc4842015-03-24 12:01:30 +01002112
Victor Stinner3a228ab2018-11-01 00:26:41 +01002113 /* Check if the current thread has a Python thread state
2114 and holds the GIL */
2115 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2116 if (tss_tstate != NULL) {
Victor Stinner50b48572018-11-01 01:51:40 +01002117 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner3a228ab2018-11-01 00:26:41 +01002118 if (tss_tstate != tstate) {
2119 /* The Python thread does not hold the GIL */
2120 tss_tstate = NULL;
2121 }
2122 }
2123 else {
2124 /* Py_FatalError() has been called from a C thread
2125 which has no Python thread state. */
2126 }
2127 int has_tstate_and_gil = (tss_tstate != NULL);
2128
2129 if (has_tstate_and_gil) {
2130 /* If an exception is set, print the exception with its traceback */
2131 if (!_Py_FatalError_PrintExc(fd)) {
2132 /* No exception is set, or an exception is set without traceback */
2133 _Py_FatalError_DumpTracebacks(fd);
2134 }
2135 }
2136 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002137 _Py_FatalError_DumpTracebacks(fd);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002138 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002139
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002140 /* The main purpose of faulthandler is to display the traceback.
2141 This function already did its best to display a traceback.
2142 Disable faulthandler to prevent writing a second traceback
2143 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002144 _PyFaulthandler_Fini();
2145
Victor Stinner791da1c2016-03-14 16:53:12 +01002146 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002147 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002148 /* Flush sys.stdout and sys.stderr */
2149 flush_std_files();
2150 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002151
Nick Coghland6009512014-11-20 21:39:37 +10002152#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002153 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002154#endif /* MS_WINDOWS */
2155
2156exit:
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002157 if (status < 0) {
Victor Stinner53345a42015-03-25 01:55:14 +01002158#if defined(MS_WINDOWS) && defined(_DEBUG)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002159 DebugBreak();
Nick Coghland6009512014-11-20 21:39:37 +10002160#endif
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002161 abort();
2162 }
2163 else {
2164 exit(status);
2165 }
2166}
2167
Victor Stinner19760862017-12-20 01:41:59 +01002168void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002169Py_FatalError(const char *msg)
2170{
2171 fatal_error(NULL, msg, -1);
2172}
2173
Victor Stinner19760862017-12-20 01:41:59 +01002174void _Py_NO_RETURN
Victor Stinnerdfe88472019-03-01 12:14:41 +01002175_Py_ExitInitError(_PyInitError err)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002176{
Victor Stinnerdb719752019-05-01 05:35:33 +02002177 if (_Py_INIT_IS_EXIT(err)) {
Victor Stinnerdfe88472019-03-01 12:14:41 +01002178 exit(err.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002179 }
2180 else if (_Py_INIT_IS_ERROR(err)) {
2181 fatal_error(err._func, err.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002182 }
2183 else {
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002184 Py_FatalError("_Py_ExitInitError() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002185 }
Nick Coghland6009512014-11-20 21:39:37 +10002186}
2187
2188/* Clean up and exit */
2189
Victor Stinnerd7292b52016-06-17 12:29:00 +02002190# include "pythread.h"
Nick Coghland6009512014-11-20 21:39:37 +10002191
Nick Coghland6009512014-11-20 21:39:37 +10002192/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002193void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002194{
Victor Stinnercaba55b2018-08-03 15:33:52 +02002195 PyInterpreterState *is = _PyInterpreterState_Get();
Marcel Plch776407f2017-12-20 11:17:58 +01002196
Antoine Pitroufc5db952017-12-13 02:29:07 +01002197 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002198 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2199
2200 is->pyexitfunc = func;
2201 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002202}
2203
2204static void
Marcel Plch776407f2017-12-20 11:17:58 +01002205call_py_exitfuncs(PyInterpreterState *istate)
Nick Coghland6009512014-11-20 21:39:37 +10002206{
Marcel Plch776407f2017-12-20 11:17:58 +01002207 if (istate->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002208 return;
2209
Marcel Plch776407f2017-12-20 11:17:58 +01002210 (*istate->pyexitfunc)(istate->pyexitmodule);
Nick Coghland6009512014-11-20 21:39:37 +10002211 PyErr_Clear();
2212}
2213
2214/* Wait until threading._shutdown completes, provided
2215 the threading module was imported in the first place.
2216 The shutdown routine will wait until all non-daemon
2217 "threading" threads have completed. */
2218static void
2219wait_for_thread_shutdown(void)
2220{
Nick Coghland6009512014-11-20 21:39:37 +10002221 _Py_IDENTIFIER(_shutdown);
2222 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002223 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002224 if (threading == NULL) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002225 if (PyErr_Occurred()) {
2226 PyErr_WriteUnraisable(NULL);
2227 }
2228 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002229 return;
2230 }
Victor Stinner3466bde2016-09-05 18:16:01 -07002231 result = _PyObject_CallMethodId(threading, &PyId__shutdown, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10002232 if (result == NULL) {
2233 PyErr_WriteUnraisable(threading);
2234 }
2235 else {
2236 Py_DECREF(result);
2237 }
2238 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002239}
2240
2241#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002242int Py_AtExit(void (*func)(void))
2243{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002244 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002245 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002246 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002247 return 0;
2248}
2249
2250static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002251call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002252{
Victor Stinner8e91c242019-04-24 17:24:01 +02002253 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002254 /* pop last function from the list */
2255 runtime->nexitfuncs--;
2256 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2257 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2258
2259 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002260 }
Nick Coghland6009512014-11-20 21:39:37 +10002261
2262 fflush(stdout);
2263 fflush(stderr);
2264}
2265
Victor Stinnercfc88312018-08-01 16:41:25 +02002266void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002267Py_Exit(int sts)
2268{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002269 if (Py_FinalizeEx() < 0) {
2270 sts = 120;
2271 }
Nick Coghland6009512014-11-20 21:39:37 +10002272
2273 exit(sts);
2274}
2275
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002276static _PyInitError
Victor Stinner43fc3bb2019-05-02 11:54:20 -04002277init_signals(void)
Nick Coghland6009512014-11-20 21:39:37 +10002278{
2279#ifdef SIGPIPE
2280 PyOS_setsig(SIGPIPE, SIG_IGN);
2281#endif
2282#ifdef SIGXFZ
2283 PyOS_setsig(SIGXFZ, SIG_IGN);
2284#endif
2285#ifdef SIGXFSZ
2286 PyOS_setsig(SIGXFSZ, SIG_IGN);
2287#endif
2288 PyOS_InitInterrupts(); /* May imply initsignal() */
2289 if (PyErr_Occurred()) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002290 return _Py_INIT_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002291 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002292 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002293}
2294
2295
2296/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2297 *
2298 * All of the code in this function must only use async-signal-safe functions,
2299 * listed at `man 7 signal` or
2300 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2301 */
2302void
2303_Py_RestoreSignals(void)
2304{
2305#ifdef SIGPIPE
2306 PyOS_setsig(SIGPIPE, SIG_DFL);
2307#endif
2308#ifdef SIGXFZ
2309 PyOS_setsig(SIGXFZ, SIG_DFL);
2310#endif
2311#ifdef SIGXFSZ
2312 PyOS_setsig(SIGXFSZ, SIG_DFL);
2313#endif
2314}
2315
2316
2317/*
2318 * The file descriptor fd is considered ``interactive'' if either
2319 * a) isatty(fd) is TRUE, or
2320 * b) the -i flag was given, and the filename associated with
2321 * the descriptor is NULL or "<stdin>" or "???".
2322 */
2323int
2324Py_FdIsInteractive(FILE *fp, const char *filename)
2325{
2326 if (isatty((int)fileno(fp)))
2327 return 1;
2328 if (!Py_InteractiveFlag)
2329 return 0;
2330 return (filename == NULL) ||
2331 (strcmp(filename, "<stdin>") == 0) ||
2332 (strcmp(filename, "???") == 0);
2333}
2334
2335
Nick Coghland6009512014-11-20 21:39:37 +10002336/* Wrappers around sigaction() or signal(). */
2337
2338PyOS_sighandler_t
2339PyOS_getsig(int sig)
2340{
2341#ifdef HAVE_SIGACTION
2342 struct sigaction context;
2343 if (sigaction(sig, NULL, &context) == -1)
2344 return SIG_ERR;
2345 return context.sa_handler;
2346#else
2347 PyOS_sighandler_t handler;
2348/* Special signal handling for the secure CRT in Visual Studio 2005 */
2349#if defined(_MSC_VER) && _MSC_VER >= 1400
2350 switch (sig) {
2351 /* Only these signals are valid */
2352 case SIGINT:
2353 case SIGILL:
2354 case SIGFPE:
2355 case SIGSEGV:
2356 case SIGTERM:
2357 case SIGBREAK:
2358 case SIGABRT:
2359 break;
2360 /* Don't call signal() with other values or it will assert */
2361 default:
2362 return SIG_ERR;
2363 }
2364#endif /* _MSC_VER && _MSC_VER >= 1400 */
2365 handler = signal(sig, SIG_IGN);
2366 if (handler != SIG_ERR)
2367 signal(sig, handler);
2368 return handler;
2369#endif
2370}
2371
2372/*
2373 * All of the code in this function must only use async-signal-safe functions,
2374 * listed at `man 7 signal` or
2375 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2376 */
2377PyOS_sighandler_t
2378PyOS_setsig(int sig, PyOS_sighandler_t handler)
2379{
2380#ifdef HAVE_SIGACTION
2381 /* Some code in Modules/signalmodule.c depends on sigaction() being
2382 * used here if HAVE_SIGACTION is defined. Fix that if this code
2383 * changes to invalidate that assumption.
2384 */
2385 struct sigaction context, ocontext;
2386 context.sa_handler = handler;
2387 sigemptyset(&context.sa_mask);
2388 context.sa_flags = 0;
2389 if (sigaction(sig, &context, &ocontext) == -1)
2390 return SIG_ERR;
2391 return ocontext.sa_handler;
2392#else
2393 PyOS_sighandler_t oldhandler;
2394 oldhandler = signal(sig, handler);
2395#ifdef HAVE_SIGINTERRUPT
2396 siginterrupt(sig, 1);
2397#endif
2398 return oldhandler;
2399#endif
2400}
2401
2402#ifdef __cplusplus
2403}
2404#endif