blob: 2a633cf1cf92733f4577146368c4757e0f31969b [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 Stinnerb36e5d62019-04-29 11:15:56 +02007#include "pycore_coreconfig.h"
Victor Stinner99fcc612019-04-29 13:04:07 +02008#include "pycore_context.h"
Victor Stinner353933e2018-11-23 13:08:26 +01009#include "pycore_fileutils.h"
Victor Stinner27e2d1f2018-11-01 00:52:28 +010010#include "pycore_hamt.h"
Victor Stinnera1c249c2018-11-01 03:15:58 +010011#include "pycore_pathconfig.h"
Victor Stinner621cebe2018-11-12 16:53:38 +010012#include "pycore_pylifecycle.h"
13#include "pycore_pymem.h"
14#include "pycore_pystate.h"
Nick Coghland6009512014-11-20 21:39:37 +100015#include "grammar.h"
16#include "node.h"
17#include "token.h"
18#include "parsetok.h"
19#include "errcode.h"
20#include "code.h"
21#include "symtable.h"
22#include "ast.h"
23#include "marshal.h"
24#include "osdefs.h"
25#include <locale.h>
26
27#ifdef HAVE_SIGNAL_H
28#include <signal.h>
29#endif
30
31#ifdef MS_WINDOWS
32#include "malloc.h" /* for alloca */
33#endif
34
35#ifdef HAVE_LANGINFO_H
36#include <langinfo.h>
37#endif
38
39#ifdef MS_WINDOWS
40#undef BYTE
41#include "windows.h"
Steve Dower39294992016-08-30 21:22:36 -070042
43extern PyTypeObject PyWindowsConsoleIO_Type;
44#define PyWindowsConsoleIO_Check(op) (PyObject_TypeCheck((op), &PyWindowsConsoleIO_Type))
Nick Coghland6009512014-11-20 21:39:37 +100045#endif
46
47_Py_IDENTIFIER(flush);
48_Py_IDENTIFIER(name);
49_Py_IDENTIFIER(stdin);
50_Py_IDENTIFIER(stdout);
51_Py_IDENTIFIER(stderr);
Eric Snow3f9eee62017-09-15 16:35:20 -060052_Py_IDENTIFIER(threading);
Nick Coghland6009512014-11-20 21:39:37 +100053
54#ifdef __cplusplus
55extern "C" {
56#endif
57
Nick Coghland6009512014-11-20 21:39:37 +100058extern grammar _PyParser_Grammar; /* From graminit.c */
59
60/* Forward */
Victor Stinnerf7e5b562017-11-15 15:48:08 -080061static _PyInitError add_main_module(PyInterpreterState *interp);
Victor Stinner43fc3bb2019-05-02 11:54:20 -040062static _PyInitError init_import_size(void);
Victor Stinner91106cd2017-12-13 12:29:09 +010063static _PyInitError init_sys_streams(PyInterpreterState *interp);
Victor Stinner43fc3bb2019-05-02 11:54:20 -040064static _PyInitError init_signals(void);
Marcel Plch776407f2017-12-20 11:17:58 +010065static void call_py_exitfuncs(PyInterpreterState *);
Nick Coghland6009512014-11-20 21:39:37 +100066static void wait_for_thread_shutdown(void);
Victor Stinner8e91c242019-04-24 17:24:01 +020067static void call_ll_exitfuncs(_PyRuntimeState *runtime);
Nick Coghland6009512014-11-20 21:39:37 +100068
Gregory P. Smith38f11cc2019-02-16 12:57:40 -080069int _Py_UnhandledKeyboardInterrupt = 0;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080070_PyRuntimeState _PyRuntime = _PyRuntimeState_INIT;
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010071static int runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060072
Victor Stinnerf7e5b562017-11-15 15:48:08 -080073_PyInitError
Eric Snow2ebc5ce2017-09-07 23:51:28 -060074_PyRuntime_Initialize(void)
75{
76 /* XXX We only initialize once in the process, which aligns with
77 the static initialization of the former globals now found in
78 _PyRuntime. However, _PyRuntime *should* be initialized with
79 every Py_Initialize() call, but doing so breaks the runtime.
80 This is because the runtime state is not properly finalized
81 currently. */
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010082 if (runtime_initialized) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -080083 return _Py_INIT_OK();
84 }
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010085 runtime_initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080086
87 return _PyRuntimeState_Init(&_PyRuntime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -060088}
89
90void
91_PyRuntime_Finalize(void)
92{
93 _PyRuntimeState_Fini(&_PyRuntime);
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010094 runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060095}
96
97int
98_Py_IsFinalizing(void)
99{
100 return _PyRuntime.finalizing != NULL;
101}
102
Nick Coghland6009512014-11-20 21:39:37 +1000103/* Hack to force loading of object files */
104int (*_PyOS_mystrnicmp_hack)(const char *, const char *, Py_ssize_t) = \
105 PyOS_mystrnicmp; /* Python/pystrcmp.o */
106
107/* PyModule_GetWarningsModule is no longer necessary as of 2.6
108since _warnings is builtin. This API should not be used. */
109PyObject *
110PyModule_GetWarningsModule(void)
111{
112 return PyImport_ImportModule("warnings");
113}
114
Eric Snowc7ec9982017-05-23 23:00:52 -0700115
Eric Snow1abcf672017-05-23 21:46:51 -0700116/* APIs to access the initialization flags
117 *
118 * Can be called prior to Py_Initialize.
119 */
Nick Coghland6009512014-11-20 21:39:37 +1000120
Eric Snow1abcf672017-05-23 21:46:51 -0700121int
122_Py_IsCoreInitialized(void)
123{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600124 return _PyRuntime.core_initialized;
Eric Snow1abcf672017-05-23 21:46:51 -0700125}
Nick Coghland6009512014-11-20 21:39:37 +1000126
127int
128Py_IsInitialized(void)
129{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600130 return _PyRuntime.initialized;
Nick Coghland6009512014-11-20 21:39:37 +1000131}
132
Nick Coghlan6ea41862017-06-11 13:16:15 +1000133
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000134/* Global initializations. Can be undone by Py_FinalizeEx(). Don't
135 call this twice without an intervening Py_FinalizeEx() call. When
Nick Coghland6009512014-11-20 21:39:37 +1000136 initializations fail, a fatal error is issued and the function does
137 not return. On return, the first thread and interpreter state have
138 been created.
139
140 Locking: you must hold the interpreter lock while calling this.
141 (If the lock has not yet been initialized, that's equivalent to
142 having the lock, but you cannot use multiple threads.)
143
144*/
145
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800146static _PyInitError
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400147init_importlib(PyInterpreterState *interp, PyObject *sysmod)
Nick Coghland6009512014-11-20 21:39:37 +1000148{
149 PyObject *importlib;
150 PyObject *impmod;
Nick Coghland6009512014-11-20 21:39:37 +1000151 PyObject *value;
152
153 /* Import _importlib through its frozen version, _frozen_importlib. */
154 if (PyImport_ImportFrozenModule("_frozen_importlib") <= 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800155 return _Py_INIT_ERR("can't import _frozen_importlib");
Nick Coghland6009512014-11-20 21:39:37 +1000156 }
157 else if (Py_VerboseFlag) {
158 PySys_FormatStderr("import _frozen_importlib # frozen\n");
159 }
160 importlib = PyImport_AddModule("_frozen_importlib");
161 if (importlib == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800162 return _Py_INIT_ERR("couldn't get _frozen_importlib from sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000163 }
164 interp->importlib = importlib;
165 Py_INCREF(interp->importlib);
166
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300167 interp->import_func = PyDict_GetItemString(interp->builtins, "__import__");
168 if (interp->import_func == NULL)
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800169 return _Py_INIT_ERR("__import__ not found");
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300170 Py_INCREF(interp->import_func);
171
Victor Stinnercd6e6942015-09-18 09:11:57 +0200172 /* Import the _imp module */
Benjamin Petersonc65ef772018-01-29 11:33:57 -0800173 impmod = PyInit__imp();
Nick Coghland6009512014-11-20 21:39:37 +1000174 if (impmod == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800175 return _Py_INIT_ERR("can't import _imp");
Nick Coghland6009512014-11-20 21:39:37 +1000176 }
177 else if (Py_VerboseFlag) {
Victor Stinnercd6e6942015-09-18 09:11:57 +0200178 PySys_FormatStderr("import _imp # builtin\n");
Nick Coghland6009512014-11-20 21:39:37 +1000179 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600180 if (_PyImport_SetModuleString("_imp", impmod) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800181 return _Py_INIT_ERR("can't save _imp to sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000182 }
183
Victor Stinnercd6e6942015-09-18 09:11:57 +0200184 /* Install importlib as the implementation of import */
Nick Coghland6009512014-11-20 21:39:37 +1000185 value = PyObject_CallMethod(importlib, "_install", "OO", sysmod, impmod);
186 if (value == NULL) {
187 PyErr_Print();
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800188 return _Py_INIT_ERR("importlib install failed");
Nick Coghland6009512014-11-20 21:39:37 +1000189 }
190 Py_DECREF(value);
191 Py_DECREF(impmod);
192
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800193 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000194}
195
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800196static _PyInitError
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400197init_importlib_external(PyInterpreterState *interp)
Eric Snow1abcf672017-05-23 21:46:51 -0700198{
199 PyObject *value;
200 value = PyObject_CallMethod(interp->importlib,
201 "_install_external_importers", "");
202 if (value == NULL) {
203 PyErr_Print();
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800204 return _Py_INIT_ERR("external importer setup failed");
Eric Snow1abcf672017-05-23 21:46:51 -0700205 }
Stéphane Wirtelab1cb802017-06-08 13:13:20 +0200206 Py_DECREF(value);
Serhiy Storchaka79d1c2e2018-09-18 22:22:29 +0300207 return _PyImportZip_Init();
Eric Snow1abcf672017-05-23 21:46:51 -0700208}
Nick Coghland6009512014-11-20 21:39:37 +1000209
Nick Coghlan6ea41862017-06-11 13:16:15 +1000210/* Helper functions to better handle the legacy C locale
211 *
212 * The legacy C locale assumes ASCII as the default text encoding, which
213 * causes problems not only for the CPython runtime, but also other
214 * components like GNU readline.
215 *
216 * Accordingly, when the CLI detects it, it attempts to coerce it to a
217 * more capable UTF-8 based alternative as follows:
218 *
219 * if (_Py_LegacyLocaleDetected()) {
220 * _Py_CoerceLegacyLocale();
221 * }
222 *
223 * See the documentation of the PYTHONCOERCECLOCALE setting for more details.
224 *
225 * Locale coercion also impacts the default error handler for the standard
226 * streams: while the usual default is "strict", the default for the legacy
227 * C locale and for any of the coercion target locales is "surrogateescape".
228 */
229
230int
231_Py_LegacyLocaleDetected(void)
232{
233#ifndef MS_WINDOWS
234 /* On non-Windows systems, the C locale is considered a legacy locale */
Nick Coghlaneb817952017-06-18 12:29:42 +1000235 /* XXX (ncoghlan): some platforms (notably Mac OS X) don't appear to treat
236 * the POSIX locale as a simple alias for the C locale, so
237 * we may also want to check for that explicitly.
238 */
Nick Coghlan6ea41862017-06-11 13:16:15 +1000239 const char *ctype_loc = setlocale(LC_CTYPE, NULL);
240 return ctype_loc != NULL && strcmp(ctype_loc, "C") == 0;
241#else
242 /* Windows uses code pages instead of locales, so no locale is legacy */
243 return 0;
244#endif
245}
246
Nick Coghlaneb817952017-06-18 12:29:42 +1000247static const char *_C_LOCALE_WARNING =
248 "Python runtime initialized with LC_CTYPE=C (a locale with default ASCII "
249 "encoding), which may cause Unicode compatibility problems. Using C.UTF-8, "
250 "C.utf8, or UTF-8 (if available) as alternative Unicode-compatible "
251 "locales is recommended.\n";
252
Nick Coghlaneb817952017-06-18 12:29:42 +1000253static void
Victor Stinner43125222019-04-24 18:23:53 +0200254emit_stderr_warning_for_legacy_locale(_PyRuntimeState *runtime)
Nick Coghlaneb817952017-06-18 12:29:42 +1000255{
Victor Stinner43125222019-04-24 18:23:53 +0200256 const _PyPreConfig *preconfig = &runtime->preconfig;
Victor Stinner20004952019-03-26 02:31:11 +0100257 if (preconfig->coerce_c_locale_warn && _Py_LegacyLocaleDetected()) {
Victor Stinnercf215042018-08-29 22:56:06 +0200258 PySys_FormatStderr("%s", _C_LOCALE_WARNING);
Nick Coghlaneb817952017-06-18 12:29:42 +1000259 }
260}
261
Nick Coghlan6ea41862017-06-11 13:16:15 +1000262typedef struct _CandidateLocale {
263 const char *locale_name; /* The locale to try as a coercion target */
264} _LocaleCoercionTarget;
265
266static _LocaleCoercionTarget _TARGET_LOCALES[] = {
267 {"C.UTF-8"},
268 {"C.utf8"},
Nick Coghlan18974c32017-06-30 00:48:14 +1000269 {"UTF-8"},
Nick Coghlan6ea41862017-06-11 13:16:15 +1000270 {NULL}
271};
272
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200273
274int
275_Py_IsLocaleCoercionTarget(const char *ctype_loc)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000276{
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200277 const _LocaleCoercionTarget *target = NULL;
278 for (target = _TARGET_LOCALES; target->locale_name; target++) {
279 if (strcmp(ctype_loc, target->locale_name) == 0) {
280 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000281 }
Victor Stinner124b9eb2018-08-29 01:29:06 +0200282 }
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200283 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000284}
285
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200286
Nick Coghlan6ea41862017-06-11 13:16:15 +1000287#ifdef PY_COERCE_C_LOCALE
Victor Stinner94540602017-12-16 04:54:22 +0100288static const char C_LOCALE_COERCION_WARNING[] =
Nick Coghlan6ea41862017-06-11 13:16:15 +1000289 "Python detected LC_CTYPE=C: LC_CTYPE coerced to %.20s (set another locale "
290 "or PYTHONCOERCECLOCALE=0 to disable this locale coercion behavior).\n";
291
292static void
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200293_coerce_default_locale_settings(int warn, const _LocaleCoercionTarget *target)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000294{
295 const char *newloc = target->locale_name;
296
297 /* Reset locale back to currently configured defaults */
xdegaye1588be62017-11-12 12:45:59 +0100298 _Py_SetLocaleFromEnv(LC_ALL);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000299
300 /* Set the relevant locale environment variable */
301 if (setenv("LC_CTYPE", newloc, 1)) {
302 fprintf(stderr,
303 "Error setting LC_CTYPE, skipping C locale coercion\n");
304 return;
305 }
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200306 if (warn) {
Victor Stinner94540602017-12-16 04:54:22 +0100307 fprintf(stderr, C_LOCALE_COERCION_WARNING, newloc);
Nick Coghlaneb817952017-06-18 12:29:42 +1000308 }
Nick Coghlan6ea41862017-06-11 13:16:15 +1000309
310 /* Reconfigure with the overridden environment variables */
xdegaye1588be62017-11-12 12:45:59 +0100311 _Py_SetLocaleFromEnv(LC_ALL);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000312}
313#endif
314
315void
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200316_Py_CoerceLegacyLocale(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000317{
318#ifdef PY_COERCE_C_LOCALE
Victor Stinner8ea09112018-09-03 17:05:18 +0200319 char *oldloc = NULL;
320
321 oldloc = _PyMem_RawStrdup(setlocale(LC_CTYPE, NULL));
322 if (oldloc == NULL) {
323 return;
324 }
325
Victor Stinner94540602017-12-16 04:54:22 +0100326 const char *locale_override = getenv("LC_ALL");
327 if (locale_override == NULL || *locale_override == '\0') {
328 /* LC_ALL is also not set (or is set to an empty string) */
329 const _LocaleCoercionTarget *target = NULL;
330 for (target = _TARGET_LOCALES; target->locale_name; target++) {
331 const char *new_locale = setlocale(LC_CTYPE,
332 target->locale_name);
333 if (new_locale != NULL) {
Victor Stinnere2510952019-05-02 11:28:57 -0400334#if !defined(_Py_FORCE_UTF8_LOCALE) && defined(HAVE_LANGINFO_H) && defined(CODESET)
Victor Stinner94540602017-12-16 04:54:22 +0100335 /* Also ensure that nl_langinfo works in this locale */
336 char *codeset = nl_langinfo(CODESET);
337 if (!codeset || *codeset == '\0') {
338 /* CODESET is not set or empty, so skip coercion */
339 new_locale = NULL;
340 _Py_SetLocaleFromEnv(LC_CTYPE);
341 continue;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000342 }
Victor Stinner94540602017-12-16 04:54:22 +0100343#endif
344 /* Successfully configured locale, so make it the default */
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200345 _coerce_default_locale_settings(warn, target);
Victor Stinner8ea09112018-09-03 17:05:18 +0200346 goto done;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000347 }
348 }
349 }
350 /* No C locale warning here, as Py_Initialize will emit one later */
Victor Stinner8ea09112018-09-03 17:05:18 +0200351
352 setlocale(LC_CTYPE, oldloc);
353
354done:
355 PyMem_RawFree(oldloc);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000356#endif
357}
358
xdegaye1588be62017-11-12 12:45:59 +0100359/* _Py_SetLocaleFromEnv() is a wrapper around setlocale(category, "") to
360 * isolate the idiosyncrasies of different libc implementations. It reads the
361 * appropriate environment variable and uses its value to select the locale for
362 * 'category'. */
363char *
364_Py_SetLocaleFromEnv(int category)
365{
Victor Stinner353933e2018-11-23 13:08:26 +0100366 char *res;
xdegaye1588be62017-11-12 12:45:59 +0100367#ifdef __ANDROID__
368 const char *locale;
369 const char **pvar;
370#ifdef PY_COERCE_C_LOCALE
371 const char *coerce_c_locale;
372#endif
373 const char *utf8_locale = "C.UTF-8";
374 const char *env_var_set[] = {
375 "LC_ALL",
376 "LC_CTYPE",
377 "LANG",
378 NULL,
379 };
380
381 /* Android setlocale(category, "") doesn't check the environment variables
382 * and incorrectly sets the "C" locale at API 24 and older APIs. We only
383 * check the environment variables listed in env_var_set. */
384 for (pvar=env_var_set; *pvar; pvar++) {
385 locale = getenv(*pvar);
386 if (locale != NULL && *locale != '\0') {
387 if (strcmp(locale, utf8_locale) == 0 ||
388 strcmp(locale, "en_US.UTF-8") == 0) {
389 return setlocale(category, utf8_locale);
390 }
391 return setlocale(category, "C");
392 }
393 }
394
395 /* Android uses UTF-8, so explicitly set the locale to C.UTF-8 if none of
396 * LC_ALL, LC_CTYPE, or LANG is set to a non-empty string.
397 * Quote from POSIX section "8.2 Internationalization Variables":
398 * "4. If the LANG environment variable is not set or is set to the empty
399 * string, the implementation-defined default locale shall be used." */
400
401#ifdef PY_COERCE_C_LOCALE
402 coerce_c_locale = getenv("PYTHONCOERCECLOCALE");
403 if (coerce_c_locale == NULL || strcmp(coerce_c_locale, "0") != 0) {
404 /* Some other ported code may check the environment variables (e.g. in
405 * extension modules), so we make sure that they match the locale
406 * configuration */
407 if (setenv("LC_CTYPE", utf8_locale, 1)) {
408 fprintf(stderr, "Warning: failed setting the LC_CTYPE "
409 "environment variable to %s\n", utf8_locale);
410 }
411 }
412#endif
Victor Stinner353933e2018-11-23 13:08:26 +0100413 res = setlocale(category, utf8_locale);
414#else /* !defined(__ANDROID__) */
415 res = setlocale(category, "");
416#endif
417 _Py_ResetForceASCII();
418 return res;
xdegaye1588be62017-11-12 12:45:59 +0100419}
420
Nick Coghlan6ea41862017-06-11 13:16:15 +1000421
Eric Snow1abcf672017-05-23 21:46:51 -0700422/* Global initializations. Can be undone by Py_Finalize(). Don't
423 call this twice without an intervening Py_Finalize() call.
424
Victor Stinner484f20d2019-03-27 02:04:16 +0100425 Every call to _Py_InitializeFromConfig, Py_Initialize or Py_InitializeEx
Eric Snow1abcf672017-05-23 21:46:51 -0700426 must have a corresponding call to Py_Finalize.
427
428 Locking: you must hold the interpreter lock while calling these APIs.
429 (If the lock has not yet been initialized, that's equivalent to
430 having the lock, but you cannot use multiple threads.)
431
432*/
433
Victor Stinner1dc6e392018-07-25 02:49:17 +0200434static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200435_Py_Initialize_ReconfigureCore(_PyRuntimeState *runtime,
436 PyInterpreterState **interp_p,
Victor Stinner1dc6e392018-07-25 02:49:17 +0200437 const _PyCoreConfig *core_config)
438{
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200439 _PyInitError err;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100440 PyThreadState *tstate = _PyThreadState_GET();
441 if (!tstate) {
442 return _Py_INIT_ERR("failed to read thread state");
443 }
444
445 PyInterpreterState *interp = tstate->interp;
446 if (interp == NULL) {
447 return _Py_INIT_ERR("can't make main interpreter");
448 }
449 *interp_p = interp;
450
Victor Stinner43125222019-04-24 18:23:53 +0200451 _PyCoreConfig_Write(core_config, runtime);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200452
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200453 err = _PyCoreConfig_Copy(&interp->core_config, core_config);
454 if (_Py_INIT_FAILED(err)) {
455 return err;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200456 }
457 core_config = &interp->core_config;
458
459 if (core_config->_install_importlib) {
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200460 err = _PyCoreConfig_SetPathConfig(core_config);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200461 if (_Py_INIT_FAILED(err)) {
462 return err;
463 }
464 }
465 return _Py_INIT_OK();
466}
467
468
Victor Stinner1dc6e392018-07-25 02:49:17 +0200469static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200470pycore_init_runtime(_PyRuntimeState *runtime,
471 const _PyCoreConfig *core_config)
Nick Coghland6009512014-11-20 21:39:37 +1000472{
Victor Stinner43125222019-04-24 18:23:53 +0200473 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +0200474 return _Py_INIT_ERR("main interpreter already initialized");
475 }
Victor Stinnerda273412017-12-15 01:46:02 +0100476
Victor Stinner43125222019-04-24 18:23:53 +0200477 _PyCoreConfig_Write(core_config, runtime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600478
Eric Snow1abcf672017-05-23 21:46:51 -0700479 /* Py_Finalize leaves _Py_Finalizing set in order to help daemon
480 * threads behave a little more gracefully at interpreter shutdown.
481 * We clobber it here so the new interpreter can start with a clean
482 * slate.
483 *
484 * However, this may still lead to misbehaviour if there are daemon
485 * threads still hanging around from a previous Py_Initialize/Finalize
486 * pair :(
487 */
Victor Stinner43125222019-04-24 18:23:53 +0200488 runtime->finalizing = NULL;
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600489
Victor Stinner43125222019-04-24 18:23:53 +0200490 _PyInitError err = _Py_HashRandomization_Init(core_config);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800491 if (_Py_INIT_FAILED(err)) {
492 return err;
493 }
494
Victor Stinner43125222019-04-24 18:23:53 +0200495 err = _PyInterpreterState_Enable(runtime);
Victor Stinnera7368ac2017-11-15 18:11:45 -0800496 if (_Py_INIT_FAILED(err)) {
497 return err;
498 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100499 return _Py_INIT_OK();
500}
Victor Stinnera7368ac2017-11-15 18:11:45 -0800501
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100502
503static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200504pycore_create_interpreter(_PyRuntimeState *runtime,
505 const _PyCoreConfig *core_config,
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100506 PyInterpreterState **interp_p)
507{
508 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnerda273412017-12-15 01:46:02 +0100509 if (interp == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800510 return _Py_INIT_ERR("can't make main interpreter");
Victor Stinnerda273412017-12-15 01:46:02 +0100511 }
Victor Stinner1dc6e392018-07-25 02:49:17 +0200512 *interp_p = interp;
Victor Stinnerda273412017-12-15 01:46:02 +0100513
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200514 _PyInitError err = _PyCoreConfig_Copy(&interp->core_config, core_config);
515 if (_Py_INIT_FAILED(err)) {
516 return err;
Victor Stinnerda273412017-12-15 01:46:02 +0100517 }
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200518 core_config = &interp->core_config;
Nick Coghland6009512014-11-20 21:39:37 +1000519
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200520 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +1000521 if (tstate == NULL)
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800522 return _Py_INIT_ERR("can't make first thread");
Nick Coghland6009512014-11-20 21:39:37 +1000523 (void) PyThreadState_Swap(tstate);
524
Victor Stinner99fcc612019-04-29 13:04:07 +0200525 /* We can't call _PyEval_FiniThreads() in Py_FinalizeEx because
526 destroying the GIL might fail when it is being referenced from
527 another running thread (see issue #9901).
Nick Coghland6009512014-11-20 21:39:37 +1000528 Instead we destroy the previously created GIL here, which ensures
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000529 that we can call Py_Initialize / Py_FinalizeEx multiple times. */
Victor Stinner99fcc612019-04-29 13:04:07 +0200530 _PyEval_FiniThreads();
Victor Stinner2914bb32018-01-29 11:57:45 +0100531
Nick Coghland6009512014-11-20 21:39:37 +1000532 /* Auto-thread-state API */
Victor Stinner43125222019-04-24 18:23:53 +0200533 _PyGILState_Init(runtime, interp, tstate);
Nick Coghland6009512014-11-20 21:39:37 +1000534
Victor Stinner2914bb32018-01-29 11:57:45 +0100535 /* Create the GIL */
536 PyEval_InitThreads();
537
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100538 return _Py_INIT_OK();
539}
Nick Coghland6009512014-11-20 21:39:37 +1000540
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100541
542static _PyInitError
543pycore_init_types(void)
544{
Victor Stinnerab672812019-01-23 15:04:40 +0100545 _PyInitError err = _PyTypes_Init();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100546 if (_Py_INIT_FAILED(err)) {
547 return err;
548 }
549
550 err = _PyUnicode_Init();
551 if (_Py_INIT_FAILED(err)) {
552 return err;
553 }
554
555 if (_PyStructSequence_Init() < 0) {
556 return _Py_INIT_ERR("can't initialize structseq");
557 }
558
559 if (!_PyLong_Init()) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800560 return _Py_INIT_ERR("can't init longs");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100561 }
Nick Coghland6009512014-11-20 21:39:37 +1000562
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100563 err = _PyExc_Init();
564 if (_Py_INIT_FAILED(err)) {
565 return err;
566 }
567
568 if (!_PyFloat_Init()) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800569 return _Py_INIT_ERR("can't init float");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100570 }
Nick Coghland6009512014-11-20 21:39:37 +1000571
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100572 if (!_PyContext_Init()) {
573 return _Py_INIT_ERR("can't init context");
574 }
575 return _Py_INIT_OK();
576}
577
578
579static _PyInitError
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100580pycore_init_builtins(PyInterpreterState *interp)
581{
582 PyObject *bimod = _PyBuiltin_Init();
583 if (bimod == NULL) {
584 return _Py_INIT_ERR("can't initialize builtins modules");
585 }
586 _PyImport_FixupBuiltin(bimod, "builtins", interp->modules);
587
588 interp->builtins = PyModule_GetDict(bimod);
589 if (interp->builtins == NULL) {
590 return _Py_INIT_ERR("can't initialize builtins dict");
591 }
592 Py_INCREF(interp->builtins);
593
594 _PyInitError err = _PyBuiltins_AddExceptions(bimod);
595 if (_Py_INIT_FAILED(err)) {
596 return err;
597 }
598 return _Py_INIT_OK();
599}
600
601
602static _PyInitError
603pycore_init_import_warnings(PyInterpreterState *interp, PyObject *sysmod)
604{
605 _PyInitError err = _PyImport_Init(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800606 if (_Py_INIT_FAILED(err)) {
607 return err;
608 }
Nick Coghland6009512014-11-20 21:39:37 +1000609
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800610 err = _PyImportHooks_Init();
611 if (_Py_INIT_FAILED(err)) {
612 return err;
613 }
Nick Coghland6009512014-11-20 21:39:37 +1000614
615 /* Initialize _warnings. */
Victor Stinner5d862462017-12-19 11:35:58 +0100616 if (_PyWarnings_Init() == NULL) {
Victor Stinner1f151112017-11-23 10:43:14 +0100617 return _Py_INIT_ERR("can't initialize warnings");
618 }
Nick Coghland6009512014-11-20 21:39:37 +1000619
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100620 if (interp->core_config._install_importlib) {
621 err = _PyCoreConfig_SetPathConfig(&interp->core_config);
Victor Stinnerb1147e42018-07-21 02:06:16 +0200622 if (_Py_INIT_FAILED(err)) {
623 return err;
624 }
625 }
626
Eric Snow1abcf672017-05-23 21:46:51 -0700627 /* This call sets up builtin and frozen import support */
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100628 if (interp->core_config._install_importlib) {
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400629 err = init_importlib(interp, sysmod);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800630 if (_Py_INIT_FAILED(err)) {
631 return err;
632 }
Eric Snow1abcf672017-05-23 21:46:51 -0700633 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100634 return _Py_INIT_OK();
635}
636
637
638static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200639_Py_InitializeCore_impl(_PyRuntimeState *runtime,
640 PyInterpreterState **interp_p,
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100641 const _PyCoreConfig *core_config)
642{
643 PyInterpreterState *interp;
644
Victor Stinner43125222019-04-24 18:23:53 +0200645 _PyCoreConfig_Write(core_config, runtime);
Victor Stinner20004952019-03-26 02:31:11 +0100646
Victor Stinner43125222019-04-24 18:23:53 +0200647 _PyInitError err = pycore_init_runtime(runtime, core_config);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100648 if (_Py_INIT_FAILED(err)) {
649 return err;
650 }
651
Victor Stinner43125222019-04-24 18:23:53 +0200652 err = pycore_create_interpreter(runtime, core_config, &interp);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100653 if (_Py_INIT_FAILED(err)) {
654 return err;
655 }
656 core_config = &interp->core_config;
657 *interp_p = interp;
658
659 err = pycore_init_types();
660 if (_Py_INIT_FAILED(err)) {
661 return err;
662 }
663
664 PyObject *sysmod;
Victor Stinner43125222019-04-24 18:23:53 +0200665 err = _PySys_Create(runtime, interp, &sysmod);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100666 if (_Py_INIT_FAILED(err)) {
667 return err;
668 }
669
670 err = pycore_init_builtins(interp);
671 if (_Py_INIT_FAILED(err)) {
672 return err;
673 }
674
675 err = pycore_init_import_warnings(interp, sysmod);
676 if (_Py_INIT_FAILED(err)) {
677 return err;
678 }
Eric Snow1abcf672017-05-23 21:46:51 -0700679
680 /* Only when we get here is the runtime core fully initialized */
Victor Stinner43125222019-04-24 18:23:53 +0200681 runtime->core_initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800682 return _Py_INIT_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700683}
684
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100685
Victor Stinnerf29084d2019-03-20 02:20:13 +0100686static _PyInitError
Victor Stinner5ac27a52019-03-27 13:40:14 +0100687preinit(const _PyPreConfig *src_config, const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100688{
689 _PyInitError err;
690
691 err = _PyRuntime_Initialize();
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100692 if (_Py_INIT_FAILED(err)) {
Victor Stinner5ac27a52019-03-27 13:40:14 +0100693 return err;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100694 }
Victor Stinner43125222019-04-24 18:23:53 +0200695 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100696
Victor Stinner43125222019-04-24 18:23:53 +0200697 if (runtime->pre_initialized) {
Victor Stinnerf72346c2019-03-25 17:54:58 +0100698 /* If it's already configured: ignored the new configuration */
Victor Stinner5ac27a52019-03-27 13:40:14 +0100699 return _Py_INIT_OK();
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100700 }
701
Victor Stinner5ac27a52019-03-27 13:40:14 +0100702 _PyPreConfig config = _PyPreConfig_INIT;
703
Victor Stinnerf72346c2019-03-25 17:54:58 +0100704 if (src_config) {
Victor Stinner5ac27a52019-03-27 13:40:14 +0100705 if (_PyPreConfig_Copy(&config, src_config) < 0) {
706 err = _Py_INIT_NO_MEMORY();
Victor Stinner20004952019-03-26 02:31:11 +0100707 goto done;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100708 }
709 }
710
Victor Stinner5ac27a52019-03-27 13:40:14 +0100711 err = _PyPreConfig_Read(&config, args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100712 if (_Py_INIT_FAILED(err)) {
Victor Stinner20004952019-03-26 02:31:11 +0100713 goto done;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100714 }
715
Victor Stinner5ac27a52019-03-27 13:40:14 +0100716 err = _PyPreConfig_Write(&config);
Victor Stinnerf72346c2019-03-25 17:54:58 +0100717 if (_Py_INIT_FAILED(err)) {
Victor Stinner20004952019-03-26 02:31:11 +0100718 goto done;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100719 }
720
Victor Stinner43125222019-04-24 18:23:53 +0200721 runtime->pre_initialized = 1;
Victor Stinner20004952019-03-26 02:31:11 +0100722 err = _Py_INIT_OK();
723
724done:
Victor Stinner5ac27a52019-03-27 13:40:14 +0100725 _PyPreConfig_Clear(&config);
Victor Stinner20004952019-03-26 02:31:11 +0100726 return err;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100727}
728
Victor Stinnerf72346c2019-03-25 17:54:58 +0100729_PyInitError
Victor Stinner5ac27a52019-03-27 13:40:14 +0100730_Py_PreInitializeFromArgs(const _PyPreConfig *src_config, int argc, char **argv)
Victor Stinnerf72346c2019-03-25 17:54:58 +0100731{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100732 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
733 return preinit(src_config, &args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100734}
735
736
737_PyInitError
Victor Stinner5ac27a52019-03-27 13:40:14 +0100738_Py_PreInitializeFromWideArgs(const _PyPreConfig *src_config, int argc, wchar_t **argv)
Victor Stinner20004952019-03-26 02:31:11 +0100739{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100740 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
741 return preinit(src_config, &args);
Victor Stinner20004952019-03-26 02:31:11 +0100742}
743
744
745_PyInitError
Victor Stinner5ac27a52019-03-27 13:40:14 +0100746_Py_PreInitialize(const _PyPreConfig *src_config)
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100747{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100748 return preinit(src_config, NULL);
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100749}
750
751
752_PyInitError
Victor Stinner5ac27a52019-03-27 13:40:14 +0100753_Py_PreInitializeFromCoreConfig(const _PyCoreConfig *coreconfig)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100754{
Victor Stinnerd929f182019-03-27 18:28:46 +0100755 assert(coreconfig != NULL);
Victor Stinner5ac27a52019-03-27 13:40:14 +0100756 _PyPreConfig config = _PyPreConfig_INIT;
757 _PyCoreConfig_GetCoreConfig(&config, coreconfig);
758 return _Py_PreInitialize(&config);
759 /* No need to clear config:
760 _PyCoreConfig_GetCoreConfig() doesn't allocate memory */
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100761}
762
763
764static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200765pyinit_coreconfig(_PyRuntimeState *runtime,
766 _PyCoreConfig *config,
Victor Stinner5ac27a52019-03-27 13:40:14 +0100767 const _PyCoreConfig *src_config,
768 const _PyArgv *args,
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100769 PyInterpreterState **interp_p)
770{
Victor Stinner5f38b842019-05-01 02:30:12 +0200771 _PyInitError err;
772
Victor Stinnerd929f182019-03-27 18:28:46 +0100773 if (src_config) {
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200774 err = _PyCoreConfig_Copy(config, src_config);
775 if (_Py_INIT_FAILED(err)) {
776 return err;
Victor Stinnerd929f182019-03-27 18:28:46 +0100777 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100778 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100779
Victor Stinner5f38b842019-05-01 02:30:12 +0200780 if (args) {
781 err = _PyCoreConfig_SetPyArgv(config, args);
782 if (_Py_INIT_FAILED(err)) {
783 return err;
784 }
785 }
786
787 err = _PyCoreConfig_Read(config);
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100788 if (_Py_INIT_FAILED(err)) {
789 return err;
790 }
791
Victor Stinner43125222019-04-24 18:23:53 +0200792 if (!runtime->core_initialized) {
793 return _Py_InitializeCore_impl(runtime, interp_p, config);
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100794 }
795 else {
Victor Stinner43125222019-04-24 18:23:53 +0200796 return _Py_Initialize_ReconfigureCore(runtime, interp_p, config);
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100797 }
798}
799
800
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100801/* Begin interpreter initialization
802 *
803 * On return, the first thread and interpreter state have been created,
804 * but the compiler, signal handling, multithreading and
805 * multiple interpreter support, and codec infrastructure are not yet
806 * available.
807 *
808 * The import system will support builtin and frozen modules only.
809 * The only supported io is writing to sys.stderr
810 *
811 * If any operation invoked by this function fails, a fatal error is
812 * issued and the function does not return.
813 *
814 * Any code invoked from this function should *not* assume it has access
815 * to the Python C API (unless the API is explicitly listed as being
816 * safe to call without calling Py_Initialize first)
817 */
Victor Stinner484f20d2019-03-27 02:04:16 +0100818static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200819_Py_InitializeCore(_PyRuntimeState *runtime,
820 const _PyCoreConfig *src_config,
Victor Stinner5ac27a52019-03-27 13:40:14 +0100821 const _PyArgv *args,
Victor Stinnerf8ba6f52019-03-26 16:58:50 +0100822 PyInterpreterState **interp_p)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200823{
Victor Stinnerd929f182019-03-27 18:28:46 +0100824 _PyInitError err;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200825
Victor Stinnerd929f182019-03-27 18:28:46 +0100826 if (src_config) {
827 err = _Py_PreInitializeFromCoreConfig(src_config);
828 }
829 else {
830 err = _Py_PreInitialize(NULL);
831 }
Victor Stinner1dc6e392018-07-25 02:49:17 +0200832 if (_Py_INIT_FAILED(err)) {
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100833 return err;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200834 }
835
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100836 _PyCoreConfig local_config = _PyCoreConfig_INIT;
Victor Stinner43125222019-04-24 18:23:53 +0200837 err = pyinit_coreconfig(runtime, &local_config, src_config, args, interp_p);
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100838 _PyCoreConfig_Clear(&local_config);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200839 return err;
840}
841
Victor Stinner5ac27a52019-03-27 13:40:14 +0100842
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200843/* Py_Initialize() has already been called: update the main interpreter
844 configuration. Example of bpo-34008: Py_Main() called after
845 Py_Initialize(). */
846static _PyInitError
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100847_Py_ReconfigureMainInterpreter(PyInterpreterState *interp)
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200848{
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100849 _PyCoreConfig *core_config = &interp->core_config;
850
851 PyObject *argv = _PyWstrList_AsList(&core_config->argv);
852 if (argv == NULL) {
853 return _Py_INIT_NO_MEMORY(); \
854 }
855
856 int res = PyDict_SetItemString(interp->sysdict, "argv", argv);
857 Py_DECREF(argv);
858 if (res < 0) {
859 return _Py_INIT_ERR("fail to set sys.argv");
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200860 }
861 return _Py_INIT_OK();
862}
863
Eric Snowc7ec9982017-05-23 23:00:52 -0700864/* Update interpreter state based on supplied configuration settings
865 *
866 * After calling this function, most of the restrictions on the interpreter
867 * are lifted. The only remaining incomplete settings are those related
868 * to the main module (sys.argv[0], __main__ metadata)
869 *
870 * Calling this when the interpreter is not initializing, is already
871 * initialized or without a valid current thread state is a fatal error.
872 * Other errors should be reported as normal Python exceptions with a
873 * non-zero return code.
874 */
Victor Stinner5ac27a52019-03-27 13:40:14 +0100875static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200876_Py_InitializeMainInterpreter(_PyRuntimeState *runtime,
877 PyInterpreterState *interp)
Eric Snow1abcf672017-05-23 21:46:51 -0700878{
Victor Stinner43125222019-04-24 18:23:53 +0200879 if (!runtime->core_initialized) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800880 return _Py_INIT_ERR("runtime core not initialized");
Eric Snowc7ec9982017-05-23 23:00:52 -0700881 }
Eric Snowc7ec9982017-05-23 23:00:52 -0700882
Victor Stinner1dc6e392018-07-25 02:49:17 +0200883 /* Configure the main interpreter */
Victor Stinner1dc6e392018-07-25 02:49:17 +0200884 _PyCoreConfig *core_config = &interp->core_config;
Eric Snowc7ec9982017-05-23 23:00:52 -0700885
Victor Stinner43125222019-04-24 18:23:53 +0200886 if (runtime->initialized) {
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100887 return _Py_ReconfigureMainInterpreter(interp);
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200888 }
889
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200890 if (!core_config->_install_importlib) {
Eric Snow1abcf672017-05-23 21:46:51 -0700891 /* Special mode for freeze_importlib: run with no import system
892 *
893 * This means anything which needs support from extension modules
894 * or pure Python code in the standard library won't work.
895 */
Victor Stinner43125222019-04-24 18:23:53 +0200896 runtime->initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800897 return _Py_INIT_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700898 }
Victor Stinner9316ee42017-11-25 03:17:57 +0100899
Victor Stinner33c377e2017-12-05 15:12:41 +0100900 if (_PyTime_Init() < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800901 return _Py_INIT_ERR("can't initialize time");
Victor Stinner33c377e2017-12-05 15:12:41 +0100902 }
Victor Stinner13019fd2015-04-03 13:10:54 +0200903
Victor Stinner43125222019-04-24 18:23:53 +0200904 if (_PySys_InitMain(runtime, interp) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800905 return _Py_INIT_ERR("can't finish initializing sys");
Victor Stinnerda273412017-12-15 01:46:02 +0100906 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800907
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400908 _PyInitError err = init_importlib_external(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800909 if (_Py_INIT_FAILED(err)) {
910 return err;
911 }
Nick Coghland6009512014-11-20 21:39:37 +1000912
913 /* initialize the faulthandler module */
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200914 err = _PyFaulthandler_Init(core_config->faulthandler);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800915 if (_Py_INIT_FAILED(err)) {
916 return err;
917 }
Nick Coghland6009512014-11-20 21:39:37 +1000918
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400919 err = _PyUnicode_InitEncodings(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800920 if (_Py_INIT_FAILED(err)) {
921 return err;
922 }
Nick Coghland6009512014-11-20 21:39:37 +1000923
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100924 if (core_config->install_signal_handlers) {
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400925 err = init_signals();
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800926 if (_Py_INIT_FAILED(err)) {
927 return err;
928 }
929 }
Nick Coghland6009512014-11-20 21:39:37 +1000930
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200931 if (_PyTraceMalloc_Init(core_config->tracemalloc) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800932 return _Py_INIT_ERR("can't initialize tracemalloc");
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200933 }
Nick Coghland6009512014-11-20 21:39:37 +1000934
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800935 err = add_main_module(interp);
936 if (_Py_INIT_FAILED(err)) {
937 return err;
938 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800939
Victor Stinner91106cd2017-12-13 12:29:09 +0100940 err = init_sys_streams(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -0800941 if (_Py_INIT_FAILED(err)) {
942 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800943 }
Nick Coghland6009512014-11-20 21:39:37 +1000944
945 /* Initialize warnings. */
Victor Stinner37cd9822018-11-16 11:55:35 +0100946 PyObject *warnoptions = PySys_GetObject("warnoptions");
947 if (warnoptions != NULL && PyList_Size(warnoptions) > 0)
Victor Stinner5d862462017-12-19 11:35:58 +0100948 {
Nick Coghland6009512014-11-20 21:39:37 +1000949 PyObject *warnings_module = PyImport_ImportModule("warnings");
950 if (warnings_module == NULL) {
951 fprintf(stderr, "'import warnings' failed; traceback:\n");
952 PyErr_Print();
953 }
954 Py_XDECREF(warnings_module);
955 }
956
Victor Stinner43125222019-04-24 18:23:53 +0200957 runtime->initialized = 1;
Eric Snow1abcf672017-05-23 21:46:51 -0700958
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200959 if (core_config->site_import) {
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400960 err = init_import_size(); /* Module site */
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800961 if (_Py_INIT_FAILED(err)) {
962 return err;
963 }
964 }
Victor Stinnercf215042018-08-29 22:56:06 +0200965
966#ifndef MS_WINDOWS
Victor Stinner43125222019-04-24 18:23:53 +0200967 emit_stderr_warning_for_legacy_locale(runtime);
Victor Stinnercf215042018-08-29 22:56:06 +0200968#endif
969
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800970 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000971}
972
Eric Snowc7ec9982017-05-23 23:00:52 -0700973#undef _INIT_DEBUG_PRINT
974
Victor Stinner5ac27a52019-03-27 13:40:14 +0100975static _PyInitError
976init_python(const _PyCoreConfig *config, const _PyArgv *args)
Eric Snow1abcf672017-05-23 21:46:51 -0700977{
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800978 _PyInitError err;
Victor Stinner43125222019-04-24 18:23:53 +0200979
980 err = _PyRuntime_Initialize();
981 if (_Py_INIT_FAILED(err)) {
982 return err;
983 }
984 _PyRuntimeState *runtime = &_PyRuntime;
985
986 PyInterpreterState *interp = NULL;
987 err = _Py_InitializeCore(runtime, config, args, &interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800988 if (_Py_INIT_FAILED(err)) {
Victor Stinner1dc6e392018-07-25 02:49:17 +0200989 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800990 }
Victor Stinner1dc6e392018-07-25 02:49:17 +0200991 config = &interp->core_config;
Victor Stinnerbc8ac6b2017-11-30 18:03:55 +0100992
Victor Stinner484f20d2019-03-27 02:04:16 +0100993 if (config->_init_main) {
Victor Stinner43125222019-04-24 18:23:53 +0200994 err = _Py_InitializeMainInterpreter(runtime, interp);
Victor Stinner484f20d2019-03-27 02:04:16 +0100995 if (_Py_INIT_FAILED(err)) {
996 return err;
997 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800998 }
Victor Stinner484f20d2019-03-27 02:04:16 +0100999
Victor Stinner1dc6e392018-07-25 02:49:17 +02001000 return _Py_INIT_OK();
Eric Snow1abcf672017-05-23 21:46:51 -07001001}
1002
1003
Victor Stinner5ac27a52019-03-27 13:40:14 +01001004_PyInitError
1005_Py_InitializeFromArgs(const _PyCoreConfig *config, int argc, char **argv)
1006{
1007 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
1008 return init_python(config, &args);
1009}
1010
1011
1012_PyInitError
1013_Py_InitializeFromWideArgs(const _PyCoreConfig *config, int argc, wchar_t **argv)
1014{
1015 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
1016 return init_python(config, &args);
1017}
1018
1019
1020_PyInitError
1021_Py_InitializeFromConfig(const _PyCoreConfig *config)
1022{
1023 return init_python(config, NULL);
1024}
1025
1026
Eric Snow1abcf672017-05-23 21:46:51 -07001027void
Nick Coghland6009512014-11-20 21:39:37 +10001028Py_InitializeEx(int install_sigs)
1029{
Victor Stinner43125222019-04-24 18:23:53 +02001030 _PyInitError err;
1031
1032 err = _PyRuntime_Initialize();
1033 if (_Py_INIT_FAILED(err)) {
1034 _Py_ExitInitError(err);
1035 }
1036 _PyRuntimeState *runtime = &_PyRuntime;
1037
1038 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001039 /* bpo-33932: Calling Py_Initialize() twice does nothing. */
1040 return;
1041 }
1042
Victor Stinner1dc6e392018-07-25 02:49:17 +02001043 _PyCoreConfig config = _PyCoreConfig_INIT;
1044 config.install_signal_handlers = install_sigs;
1045
Victor Stinner43125222019-04-24 18:23:53 +02001046 err = _Py_InitializeFromConfig(&config);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001047 if (_Py_INIT_FAILED(err)) {
Victor Stinnerdfe88472019-03-01 12:14:41 +01001048 _Py_ExitInitError(err);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001049 }
Nick Coghland6009512014-11-20 21:39:37 +10001050}
1051
1052void
1053Py_Initialize(void)
1054{
1055 Py_InitializeEx(1);
1056}
1057
1058
1059#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001060extern void _Py_dump_counts(FILE*);
Nick Coghland6009512014-11-20 21:39:37 +10001061#endif
1062
1063/* Flush stdout and stderr */
1064
1065static int
1066file_is_closed(PyObject *fobj)
1067{
1068 int r;
1069 PyObject *tmp = PyObject_GetAttrString(fobj, "closed");
1070 if (tmp == NULL) {
1071 PyErr_Clear();
1072 return 0;
1073 }
1074 r = PyObject_IsTrue(tmp);
1075 Py_DECREF(tmp);
1076 if (r < 0)
1077 PyErr_Clear();
1078 return r > 0;
1079}
1080
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001081static int
Nick Coghland6009512014-11-20 21:39:37 +10001082flush_std_files(void)
1083{
1084 PyObject *fout = _PySys_GetObjectId(&PyId_stdout);
1085 PyObject *ferr = _PySys_GetObjectId(&PyId_stderr);
1086 PyObject *tmp;
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001087 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001088
1089 if (fout != NULL && fout != Py_None && !file_is_closed(fout)) {
Victor Stinner3466bde2016-09-05 18:16:01 -07001090 tmp = _PyObject_CallMethodId(fout, &PyId_flush, NULL);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001091 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001092 PyErr_WriteUnraisable(fout);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001093 status = -1;
1094 }
Nick Coghland6009512014-11-20 21:39:37 +10001095 else
1096 Py_DECREF(tmp);
1097 }
1098
1099 if (ferr != NULL && ferr != Py_None && !file_is_closed(ferr)) {
Victor Stinner3466bde2016-09-05 18:16:01 -07001100 tmp = _PyObject_CallMethodId(ferr, &PyId_flush, NULL);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001101 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001102 PyErr_Clear();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001103 status = -1;
1104 }
Nick Coghland6009512014-11-20 21:39:37 +10001105 else
1106 Py_DECREF(tmp);
1107 }
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001108
1109 return status;
Nick Coghland6009512014-11-20 21:39:37 +10001110}
1111
1112/* Undo the effect of Py_Initialize().
1113
1114 Beware: if multiple interpreter and/or thread states exist, these
1115 are not wiped out; only the current thread and interpreter state
1116 are deleted. But since everything else is deleted, those other
1117 interpreter and thread states should no longer be used.
1118
1119 (XXX We should do better, e.g. wipe out all interpreters and
1120 threads.)
1121
1122 Locking: as above.
1123
1124*/
1125
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001126int
1127Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001128{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001129 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001130
Victor Stinner8e91c242019-04-24 17:24:01 +02001131 _PyRuntimeState *runtime = &_PyRuntime;
1132 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001133 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001134 }
Nick Coghland6009512014-11-20 21:39:37 +10001135
Eric Snow842a2f02019-03-15 15:47:51 -06001136 // Wrap up existing "threading"-module-created, non-daemon threads.
Nick Coghland6009512014-11-20 21:39:37 +10001137 wait_for_thread_shutdown();
1138
Eric Snow842a2f02019-03-15 15:47:51 -06001139 // Make any remaining pending calls.
Eric Snowb75b1a352019-04-12 10:20:10 -06001140 _Py_FinishPendingCalls();
Eric Snow842a2f02019-03-15 15:47:51 -06001141
Victor Stinner8e91c242019-04-24 17:24:01 +02001142 /* Get current thread state and interpreter pointer */
1143 PyThreadState *tstate = _PyThreadState_GET();
1144 PyInterpreterState *interp = tstate->interp;
1145
Nick Coghland6009512014-11-20 21:39:37 +10001146 /* The interpreter is still entirely intact at this point, and the
1147 * exit funcs may be relying on that. In particular, if some thread
1148 * or exit func is still waiting to do an import, the import machinery
1149 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001150 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001151 * Note that Threading.py uses an exit func to do a join on all the
1152 * threads created thru it, so this also protects pending imports in
1153 * the threads created via Threading.
1154 */
Nick Coghland6009512014-11-20 21:39:37 +10001155
Marcel Plch776407f2017-12-20 11:17:58 +01001156 call_py_exitfuncs(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001157
Victor Stinnerda273412017-12-15 01:46:02 +01001158 /* Copy the core config, PyInterpreterState_Delete() free
1159 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001160#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001161 int show_ref_count = interp->core_config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001162#endif
1163#ifdef Py_TRACE_REFS
Victor Stinnerda273412017-12-15 01:46:02 +01001164 int dump_refs = interp->core_config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001165#endif
1166#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001167 int malloc_stats = interp->core_config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001168#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001169
Nick Coghland6009512014-11-20 21:39:37 +10001170 /* Remaining threads (e.g. daemon threads) will automatically exit
1171 after taking the GIL (in PyEval_RestoreThread()). */
Victor Stinner8e91c242019-04-24 17:24:01 +02001172 runtime->finalizing = tstate;
1173 runtime->initialized = 0;
1174 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001175
Victor Stinnere0deff32015-03-24 13:46:18 +01001176 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001177 if (flush_std_files() < 0) {
1178 status = -1;
1179 }
Nick Coghland6009512014-11-20 21:39:37 +10001180
1181 /* Disable signal handling */
1182 PyOS_FiniInterrupts();
1183
1184 /* Collect garbage. This may call finalizers; it's nice to call these
1185 * before all modules are destroyed.
1186 * XXX If a __del__ or weakref callback is triggered here, and tries to
1187 * XXX import a module, bad things can happen, because Python no
1188 * XXX longer believes it's initialized.
1189 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1190 * XXX is easy to provoke that way. I've also seen, e.g.,
1191 * XXX Exception exceptions.ImportError: 'No module named sha'
1192 * XXX in <function callback at 0x008F5718> ignored
1193 * XXX but I'm unclear on exactly how that one happens. In any case,
1194 * XXX I haven't seen a real-life report of either of these.
1195 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001196 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001197#ifdef COUNT_ALLOCS
1198 /* With COUNT_ALLOCS, it helps to run GC multiple times:
1199 each collection might release some types from the type
1200 list, so they become garbage. */
Łukasz Langafef7e942016-09-09 21:47:46 -07001201 while (_PyGC_CollectIfEnabled() > 0)
Nick Coghland6009512014-11-20 21:39:37 +10001202 /* nothing */;
1203#endif
Eric Snowdae02762017-09-14 00:35:58 -07001204
Nick Coghland6009512014-11-20 21:39:37 +10001205 /* Destroy all modules */
1206 PyImport_Cleanup();
1207
Victor Stinnere0deff32015-03-24 13:46:18 +01001208 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001209 if (flush_std_files() < 0) {
1210 status = -1;
1211 }
Nick Coghland6009512014-11-20 21:39:37 +10001212
1213 /* Collect final garbage. This disposes of cycles created by
1214 * class definitions, for example.
1215 * XXX This is disabled because it caused too many problems. If
1216 * XXX a __del__ or weakref callback triggers here, Python code has
1217 * XXX a hard time running, because even the sys module has been
1218 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1219 * XXX One symptom is a sequence of information-free messages
1220 * XXX coming from threads (if a __del__ or callback is invoked,
1221 * XXX other threads can execute too, and any exception they encounter
1222 * XXX triggers a comedy of errors as subsystem after subsystem
1223 * XXX fails to find what it *expects* to find in sys to help report
1224 * XXX the exception and consequent unexpected failures). I've also
1225 * XXX seen segfaults then, after adding print statements to the
1226 * XXX Python code getting called.
1227 */
1228#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001229 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001230#endif
1231
1232 /* Disable tracemalloc after all Python objects have been destroyed,
1233 so it is possible to use tracemalloc in objects destructor. */
1234 _PyTraceMalloc_Fini();
1235
1236 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1237 _PyImport_Fini();
1238
1239 /* Cleanup typeobject.c's internal caches. */
1240 _PyType_Fini();
1241
1242 /* unload faulthandler module */
1243 _PyFaulthandler_Fini();
1244
1245 /* Debugging stuff */
1246#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001247 _Py_dump_counts(stderr);
Nick Coghland6009512014-11-20 21:39:37 +10001248#endif
1249 /* dump hash stats */
1250 _PyHash_Fini();
1251
Eric Snowdae02762017-09-14 00:35:58 -07001252#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001253 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001254 _PyDebug_PrintTotalRefs();
1255 }
Eric Snowdae02762017-09-14 00:35:58 -07001256#endif
Nick Coghland6009512014-11-20 21:39:37 +10001257
1258#ifdef Py_TRACE_REFS
1259 /* Display all objects still alive -- this can invoke arbitrary
1260 * __repr__ overrides, so requires a mostly-intact interpreter.
1261 * Alas, a lot of stuff may still be alive now that will be cleaned
1262 * up later.
1263 */
Victor Stinnerda273412017-12-15 01:46:02 +01001264 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001265 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001266 }
Nick Coghland6009512014-11-20 21:39:37 +10001267#endif /* Py_TRACE_REFS */
1268
1269 /* Clear interpreter state and all thread states. */
1270 PyInterpreterState_Clear(interp);
1271
1272 /* Now we decref the exception classes. After this point nothing
1273 can raise an exception. That's okay, because each Fini() method
1274 below has been checked to make sure no exceptions are ever
1275 raised.
1276 */
1277
1278 _PyExc_Fini();
1279
1280 /* Sundry finalizers */
1281 PyMethod_Fini();
1282 PyFrame_Fini();
1283 PyCFunction_Fini();
1284 PyTuple_Fini();
1285 PyList_Fini();
1286 PySet_Fini();
1287 PyBytes_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001288 PyLong_Fini();
1289 PyFloat_Fini();
1290 PyDict_Fini();
1291 PySlice_Fini();
Victor Stinner8e91c242019-04-24 17:24:01 +02001292 _PyGC_Fini(runtime);
Victor Stinner87d23a02019-04-26 05:49:26 +02001293 _PyWarnings_Fini(runtime);
Eric Snow6b4be192017-05-22 21:36:03 -07001294 _Py_HashRandomization_Fini();
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001295 _PyArg_Fini();
Yury Selivanoveb636452016-09-08 22:01:51 -07001296 PyAsyncGen_Fini();
Yury Selivanovf23746a2018-01-22 19:11:18 -05001297 _PyContext_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001298
1299 /* Cleanup Unicode implementation */
1300 _PyUnicode_Fini();
1301
Victor Stinnerb2457ef2018-08-29 13:25:36 +02001302 _Py_ClearFileSystemEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10001303
1304 /* XXX Still allocated:
1305 - various static ad-hoc pointers to interned strings
1306 - int and float free list blocks
1307 - whatever various modules and libraries allocate
1308 */
1309
1310 PyGrammar_RemoveAccelerators(&_PyParser_Grammar);
1311
1312 /* Cleanup auto-thread-state */
Victor Stinner8e91c242019-04-24 17:24:01 +02001313 _PyGILState_Fini(runtime);
Nick Coghland6009512014-11-20 21:39:37 +10001314
1315 /* Delete current thread. After this, many C API calls become crashy. */
1316 PyThreadState_Swap(NULL);
Victor Stinner8a1be612016-03-14 22:07:55 +01001317
Nick Coghland6009512014-11-20 21:39:37 +10001318 PyInterpreterState_Delete(interp);
1319
1320#ifdef Py_TRACE_REFS
1321 /* Display addresses (& refcnts) of all objects still alive.
1322 * An address can be used to find the repr of the object, printed
1323 * above by _Py_PrintReferences.
1324 */
Victor Stinnerda273412017-12-15 01:46:02 +01001325 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001326 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001327 }
Nick Coghland6009512014-11-20 21:39:37 +10001328#endif /* Py_TRACE_REFS */
Victor Stinner34be8072016-03-14 12:04:26 +01001329#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001330 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001331 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be8072016-03-14 12:04:26 +01001332 }
Nick Coghland6009512014-11-20 21:39:37 +10001333#endif
1334
Victor Stinner8e91c242019-04-24 17:24:01 +02001335 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001336
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001337 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001338 return status;
1339}
1340
1341void
1342Py_Finalize(void)
1343{
1344 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001345}
1346
1347/* Create and initialize a new interpreter and thread, and return the
1348 new thread. This requires that Py_Initialize() has been called
1349 first.
1350
1351 Unsuccessful initialization yields a NULL pointer. Note that *no*
1352 exception information is available even in this case -- the
1353 exception information is held in the thread, and there is no
1354 thread.
1355
1356 Locking: as above.
1357
1358*/
1359
Victor Stinnera7368ac2017-11-15 18:11:45 -08001360static _PyInitError
1361new_interpreter(PyThreadState **tstate_p)
Nick Coghland6009512014-11-20 21:39:37 +10001362{
Victor Stinner9316ee42017-11-25 03:17:57 +01001363 _PyInitError err;
Nick Coghland6009512014-11-20 21:39:37 +10001364
Victor Stinner43125222019-04-24 18:23:53 +02001365 err = _PyRuntime_Initialize();
1366 if (_Py_INIT_FAILED(err)) {
1367 return err;
1368 }
1369 _PyRuntimeState *runtime = &_PyRuntime;
1370
1371 if (!runtime->initialized) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001372 return _Py_INIT_ERR("Py_Initialize must be called first");
1373 }
Nick Coghland6009512014-11-20 21:39:37 +10001374
Victor Stinner8a1be612016-03-14 22:07:55 +01001375 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1376 interpreters: disable PyGILState_Check(). */
1377 _PyGILState_check_enabled = 0;
1378
Victor Stinner43125222019-04-24 18:23:53 +02001379 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001380 if (interp == NULL) {
1381 *tstate_p = NULL;
1382 return _Py_INIT_OK();
1383 }
Nick Coghland6009512014-11-20 21:39:37 +10001384
Victor Stinner43125222019-04-24 18:23:53 +02001385 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001386 if (tstate == NULL) {
1387 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001388 *tstate_p = NULL;
1389 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001390 }
1391
Victor Stinner43125222019-04-24 18:23:53 +02001392 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001393
Eric Snow1abcf672017-05-23 21:46:51 -07001394 /* Copy the current interpreter config into the new interpreter */
Victor Stinnerda273412017-12-15 01:46:02 +01001395 _PyCoreConfig *core_config;
Eric Snow1abcf672017-05-23 21:46:51 -07001396 if (save_tstate != NULL) {
Victor Stinnerda273412017-12-15 01:46:02 +01001397 core_config = &save_tstate->interp->core_config;
Eric Snow1abcf672017-05-23 21:46:51 -07001398 } else {
1399 /* No current thread state, copy from the main interpreter */
1400 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinnerda273412017-12-15 01:46:02 +01001401 core_config = &main_interp->core_config;
Victor Stinnerda273412017-12-15 01:46:02 +01001402 }
1403
Victor Stinner1a9f0d82019-05-01 15:22:52 +02001404 err = _PyCoreConfig_Copy(&interp->core_config, core_config);
1405 if (_Py_INIT_FAILED(err)) {
1406 return err;
Victor Stinnerda273412017-12-15 01:46:02 +01001407 }
Victor Stinnerd19d8d52018-07-24 13:55:48 +02001408 core_config = &interp->core_config;
Eric Snow1abcf672017-05-23 21:46:51 -07001409
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001410 err = _PyExc_Init();
1411 if (_Py_INIT_FAILED(err)) {
1412 return err;
1413 }
1414
Nick Coghland6009512014-11-20 21:39:37 +10001415 /* XXX The following is lax in error checking */
Eric Snowd393c1b2017-09-14 12:18:12 -06001416 PyObject *modules = PyDict_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001417 if (modules == NULL) {
1418 return _Py_INIT_ERR("can't make modules dictionary");
1419 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001420 interp->modules = modules;
Nick Coghland6009512014-11-20 21:39:37 +10001421
Victor Stinner43125222019-04-24 18:23:53 +02001422 PyObject *sysmod = _PyImport_FindBuiltin("sys", modules);
Eric Snowd393c1b2017-09-14 12:18:12 -06001423 if (sysmod != NULL) {
1424 interp->sysdict = PyModule_GetDict(sysmod);
Victor Stinner43125222019-04-24 18:23:53 +02001425 if (interp->sysdict == NULL) {
Eric Snowd393c1b2017-09-14 12:18:12 -06001426 goto handle_error;
Victor Stinner43125222019-04-24 18:23:53 +02001427 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001428 Py_INCREF(interp->sysdict);
1429 PyDict_SetItemString(interp->sysdict, "modules", modules);
Victor Stinner43125222019-04-24 18:23:53 +02001430 if (_PySys_InitMain(runtime, interp) < 0) {
Victor Stinnerab672812019-01-23 15:04:40 +01001431 return _Py_INIT_ERR("can't finish initializing sys");
1432 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001433 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001434 else if (PyErr_Occurred()) {
1435 goto handle_error;
1436 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001437
Victor Stinner43125222019-04-24 18:23:53 +02001438 PyObject *bimod = _PyImport_FindBuiltin("builtins", modules);
Nick Coghland6009512014-11-20 21:39:37 +10001439 if (bimod != NULL) {
1440 interp->builtins = PyModule_GetDict(bimod);
1441 if (interp->builtins == NULL)
1442 goto handle_error;
1443 Py_INCREF(interp->builtins);
1444 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001445 else if (PyErr_Occurred()) {
1446 goto handle_error;
1447 }
Nick Coghland6009512014-11-20 21:39:37 +10001448
Nick Coghland6009512014-11-20 21:39:37 +10001449 if (bimod != NULL && sysmod != NULL) {
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001450 err = _PyBuiltins_AddExceptions(bimod);
1451 if (_Py_INIT_FAILED(err)) {
1452 return err;
1453 }
Nick Coghland6009512014-11-20 21:39:37 +10001454
Victor Stinnerab672812019-01-23 15:04:40 +01001455 err = _PySys_SetPreliminaryStderr(interp->sysdict);
1456 if (_Py_INIT_FAILED(err)) {
1457 return err;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001458 }
Nick Coghland6009512014-11-20 21:39:37 +10001459
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001460 err = _PyImportHooks_Init();
1461 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001462 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001463 }
Nick Coghland6009512014-11-20 21:39:37 +10001464
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001465 err = init_importlib(interp, sysmod);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001466 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001467 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001468 }
Nick Coghland6009512014-11-20 21:39:37 +10001469
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001470 err = init_importlib_external(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001471 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001472 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001473 }
Nick Coghland6009512014-11-20 21:39:37 +10001474
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001475 err = _PyUnicode_InitEncodings(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001476 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001477 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001478 }
1479
Victor Stinner91106cd2017-12-13 12:29:09 +01001480 err = init_sys_streams(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001481 if (_Py_INIT_FAILED(err)) {
1482 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001483 }
1484
1485 err = add_main_module(interp);
1486 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001487 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001488 }
1489
Victor Stinnerd19d8d52018-07-24 13:55:48 +02001490 if (core_config->site_import) {
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001491 err = init_import_size();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001492 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001493 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001494 }
1495 }
Nick Coghland6009512014-11-20 21:39:37 +10001496 }
1497
Victor Stinnera7368ac2017-11-15 18:11:45 -08001498 if (PyErr_Occurred()) {
1499 goto handle_error;
1500 }
Nick Coghland6009512014-11-20 21:39:37 +10001501
Victor Stinnera7368ac2017-11-15 18:11:45 -08001502 *tstate_p = tstate;
1503 return _Py_INIT_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001504
Nick Coghland6009512014-11-20 21:39:37 +10001505handle_error:
1506 /* Oops, it didn't work. Undo it all. */
1507
1508 PyErr_PrintEx(0);
1509 PyThreadState_Clear(tstate);
1510 PyThreadState_Swap(save_tstate);
1511 PyThreadState_Delete(tstate);
1512 PyInterpreterState_Delete(interp);
1513
Victor Stinnera7368ac2017-11-15 18:11:45 -08001514 *tstate_p = NULL;
1515 return _Py_INIT_OK();
1516}
1517
1518PyThreadState *
1519Py_NewInterpreter(void)
1520{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001521 PyThreadState *tstate = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001522 _PyInitError err = new_interpreter(&tstate);
1523 if (_Py_INIT_FAILED(err)) {
Victor Stinnerdfe88472019-03-01 12:14:41 +01001524 _Py_ExitInitError(err);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001525 }
1526 return tstate;
1527
Nick Coghland6009512014-11-20 21:39:37 +10001528}
1529
1530/* Delete an interpreter and its last thread. This requires that the
1531 given thread state is current, that the thread has no remaining
1532 frames, and that it is its interpreter's only remaining thread.
1533 It is a fatal error to violate these constraints.
1534
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001535 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001536 everything, regardless.)
1537
1538 Locking: as above.
1539
1540*/
1541
1542void
1543Py_EndInterpreter(PyThreadState *tstate)
1544{
1545 PyInterpreterState *interp = tstate->interp;
1546
Victor Stinner50b48572018-11-01 01:51:40 +01001547 if (tstate != _PyThreadState_GET())
Nick Coghland6009512014-11-20 21:39:37 +10001548 Py_FatalError("Py_EndInterpreter: thread is not current");
1549 if (tstate->frame != NULL)
1550 Py_FatalError("Py_EndInterpreter: thread still has a frame");
Eric Snow5be45a62019-03-08 22:47:07 -07001551 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001552
Eric Snow842a2f02019-03-15 15:47:51 -06001553 // Wrap up existing "threading"-module-created, non-daemon threads.
Nick Coghland6009512014-11-20 21:39:37 +10001554 wait_for_thread_shutdown();
1555
Marcel Plch776407f2017-12-20 11:17:58 +01001556 call_py_exitfuncs(interp);
1557
Nick Coghland6009512014-11-20 21:39:37 +10001558 if (tstate != interp->tstate_head || tstate->next != NULL)
1559 Py_FatalError("Py_EndInterpreter: not the last thread");
1560
1561 PyImport_Cleanup();
1562 PyInterpreterState_Clear(interp);
1563 PyThreadState_Swap(NULL);
1564 PyInterpreterState_Delete(interp);
1565}
1566
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001567/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001568
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001569static _PyInitError
1570add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001571{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001572 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001573 m = PyImport_AddModule("__main__");
1574 if (m == NULL)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001575 return _Py_INIT_ERR("can't create __main__ module");
1576
Nick Coghland6009512014-11-20 21:39:37 +10001577 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001578 ann_dict = PyDict_New();
1579 if ((ann_dict == NULL) ||
1580 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001581 return _Py_INIT_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001582 }
1583 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001584
Nick Coghland6009512014-11-20 21:39:37 +10001585 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1586 PyObject *bimod = PyImport_ImportModule("builtins");
1587 if (bimod == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001588 return _Py_INIT_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001589 }
1590 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001591 return _Py_INIT_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001592 }
1593 Py_DECREF(bimod);
1594 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001595
Nick Coghland6009512014-11-20 21:39:37 +10001596 /* Main is a little special - imp.is_builtin("__main__") will return
1597 * False, but BuiltinImporter is still the most appropriate initial
1598 * setting for its __loader__ attribute. A more suitable value will
1599 * be set if __main__ gets further initialized later in the startup
1600 * process.
1601 */
1602 loader = PyDict_GetItemString(d, "__loader__");
1603 if (loader == NULL || loader == Py_None) {
1604 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1605 "BuiltinImporter");
1606 if (loader == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001607 return _Py_INIT_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001608 }
1609 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001610 return _Py_INIT_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001611 }
1612 Py_DECREF(loader);
1613 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001614 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001615}
1616
Nick Coghland6009512014-11-20 21:39:37 +10001617/* Import the site module (not into __main__ though) */
1618
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001619static _PyInitError
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001620init_import_size(void)
Nick Coghland6009512014-11-20 21:39:37 +10001621{
1622 PyObject *m;
1623 m = PyImport_ImportModule("site");
1624 if (m == NULL) {
Victor Stinnerdb719752019-05-01 05:35:33 +02001625 return _Py_INIT_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001626 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001627 Py_DECREF(m);
1628 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001629}
1630
Victor Stinner874dbe82015-09-04 17:29:57 +02001631/* Check if a file descriptor is valid or not.
1632 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1633static int
1634is_valid_fd(int fd)
1635{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001636/* dup() is faster than fstat(): fstat() can require input/output operations,
1637 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1638 startup. Problem: dup() doesn't check if the file descriptor is valid on
1639 some platforms.
1640
1641 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1642 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1643 EBADF. FreeBSD has similar issue (bpo-32849).
1644
1645 Only use dup() on platforms where dup() is enough to detect invalid FD in
1646 corner cases: on Linux and Windows (bpo-32849). */
1647#if defined(__linux__) || defined(MS_WINDOWS)
1648 if (fd < 0) {
1649 return 0;
1650 }
1651 int fd2;
1652
1653 _Py_BEGIN_SUPPRESS_IPH
1654 fd2 = dup(fd);
1655 if (fd2 >= 0) {
1656 close(fd2);
1657 }
1658 _Py_END_SUPPRESS_IPH
1659
1660 return (fd2 >= 0);
1661#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001662 struct stat st;
1663 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001664#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001665}
1666
1667/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001668static PyObject*
Victor Stinnerfbca9082018-08-30 00:50:45 +02001669create_stdio(const _PyCoreConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001670 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001671 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001672{
1673 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1674 const char* mode;
1675 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001676 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001677 int buffering, isatty;
1678 _Py_IDENTIFIER(open);
1679 _Py_IDENTIFIER(isatty);
1680 _Py_IDENTIFIER(TextIOWrapper);
1681 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001682 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001683
Victor Stinner874dbe82015-09-04 17:29:57 +02001684 if (!is_valid_fd(fd))
1685 Py_RETURN_NONE;
1686
Nick Coghland6009512014-11-20 21:39:37 +10001687 /* stdin is always opened in buffered mode, first because it shouldn't
1688 make a difference in common use cases, second because TextIOWrapper
1689 depends on the presence of a read1() method which only exists on
1690 buffered streams.
1691 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001692 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001693 buffering = 0;
1694 else
1695 buffering = -1;
1696 if (write_mode)
1697 mode = "wb";
1698 else
1699 mode = "rb";
1700 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOi",
1701 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001702 Py_None, Py_None, /* encoding, errors */
1703 Py_None, 0); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001704 if (buf == NULL)
1705 goto error;
1706
1707 if (buffering) {
1708 _Py_IDENTIFIER(raw);
1709 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1710 if (raw == NULL)
1711 goto error;
1712 }
1713 else {
1714 raw = buf;
1715 Py_INCREF(raw);
1716 }
1717
Steve Dower39294992016-08-30 21:22:36 -07001718#ifdef MS_WINDOWS
1719 /* Windows console IO is always UTF-8 encoded */
1720 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001721 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001722#endif
1723
Nick Coghland6009512014-11-20 21:39:37 +10001724 text = PyUnicode_FromString(name);
1725 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1726 goto error;
Victor Stinner3466bde2016-09-05 18:16:01 -07001727 res = _PyObject_CallMethodId(raw, &PyId_isatty, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10001728 if (res == NULL)
1729 goto error;
1730 isatty = PyObject_IsTrue(res);
1731 Py_DECREF(res);
1732 if (isatty == -1)
1733 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001734 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001735 write_through = Py_True;
1736 else
1737 write_through = Py_False;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001738 if (isatty && buffered_stdio)
Nick Coghland6009512014-11-20 21:39:37 +10001739 line_buffering = Py_True;
1740 else
1741 line_buffering = Py_False;
1742
1743 Py_CLEAR(raw);
1744 Py_CLEAR(text);
1745
1746#ifdef MS_WINDOWS
1747 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1748 newlines to "\n".
1749 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1750 newline = NULL;
1751#else
1752 /* sys.stdin: split lines at "\n".
1753 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1754 newline = "\n";
1755#endif
1756
Victor Stinner709d23d2019-05-02 14:56:30 -04001757 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1758 if (encoding_str == NULL) {
1759 Py_CLEAR(buf);
1760 goto error;
1761 }
1762
1763 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1764 if (errors_str == NULL) {
1765 Py_CLEAR(buf);
1766 Py_CLEAR(encoding_str);
1767 goto error;
1768 }
1769
1770 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1771 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001772 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001773 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001774 Py_CLEAR(encoding_str);
1775 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001776 if (stream == NULL)
1777 goto error;
1778
1779 if (write_mode)
1780 mode = "w";
1781 else
1782 mode = "r";
1783 text = PyUnicode_FromString(mode);
1784 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1785 goto error;
1786 Py_CLEAR(text);
1787 return stream;
1788
1789error:
1790 Py_XDECREF(buf);
1791 Py_XDECREF(stream);
1792 Py_XDECREF(text);
1793 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001794
Victor Stinner874dbe82015-09-04 17:29:57 +02001795 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1796 /* Issue #24891: the file descriptor was closed after the first
1797 is_valid_fd() check was called. Ignore the OSError and set the
1798 stream to None. */
1799 PyErr_Clear();
1800 Py_RETURN_NONE;
1801 }
1802 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001803}
1804
1805/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinnera7368ac2017-11-15 18:11:45 -08001806static _PyInitError
Victor Stinner91106cd2017-12-13 12:29:09 +01001807init_sys_streams(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001808{
1809 PyObject *iomod = NULL, *wrapper;
1810 PyObject *bimod = NULL;
1811 PyObject *m;
1812 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001813 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001814 PyObject * encoding_attr;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001815 _PyInitError res = _Py_INIT_OK();
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001816 _PyCoreConfig *config = &interp->core_config;
1817
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001818 /* Check that stdin is not a directory
1819 Using shell redirection, you can redirect stdin to a directory,
1820 crashing the Python interpreter. Catch this common mistake here
1821 and output a useful error message. Note that under MS Windows,
1822 the shell already prevents that. */
1823#ifndef MS_WINDOWS
1824 struct _Py_stat_struct sb;
1825 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1826 S_ISDIR(sb.st_mode)) {
Victor Stinnerdb719752019-05-01 05:35:33 +02001827 return _Py_INIT_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001828 }
1829#endif
1830
Nick Coghland6009512014-11-20 21:39:37 +10001831 /* Hack to avoid a nasty recursion issue when Python is invoked
1832 in verbose mode: pre-import the Latin-1 and UTF-8 codecs */
1833 if ((m = PyImport_ImportModule("encodings.utf_8")) == NULL) {
1834 goto error;
1835 }
1836 Py_DECREF(m);
1837
1838 if (!(m = PyImport_ImportModule("encodings.latin_1"))) {
1839 goto error;
1840 }
1841 Py_DECREF(m);
1842
1843 if (!(bimod = PyImport_ImportModule("builtins"))) {
1844 goto error;
1845 }
1846
1847 if (!(iomod = PyImport_ImportModule("io"))) {
1848 goto error;
1849 }
1850 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1851 goto error;
1852 }
1853
1854 /* Set builtins.open */
1855 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1856 Py_DECREF(wrapper);
1857 goto error;
1858 }
1859 Py_DECREF(wrapper);
1860
Nick Coghland6009512014-11-20 21:39:37 +10001861 /* Set sys.stdin */
1862 fd = fileno(stdin);
1863 /* Under some conditions stdin, stdout and stderr may not be connected
1864 * and fileno() may point to an invalid file descriptor. For example
1865 * GUI apps don't have valid standard streams by default.
1866 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001867 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001868 config->stdio_encoding,
1869 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001870 if (std == NULL)
1871 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001872 PySys_SetObject("__stdin__", std);
1873 _PySys_SetObjectId(&PyId_stdin, std);
1874 Py_DECREF(std);
1875
1876 /* Set sys.stdout */
1877 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001878 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001879 config->stdio_encoding,
1880 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001881 if (std == NULL)
1882 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001883 PySys_SetObject("__stdout__", std);
1884 _PySys_SetObjectId(&PyId_stdout, std);
1885 Py_DECREF(std);
1886
1887#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
1888 /* Set sys.stderr, replaces the preliminary stderr */
1889 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001890 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001891 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04001892 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02001893 if (std == NULL)
1894 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001895
1896 /* Same as hack above, pre-import stderr's codec to avoid recursion
1897 when import.c tries to write to stderr in verbose mode. */
1898 encoding_attr = PyObject_GetAttrString(std, "encoding");
1899 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001900 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10001901 if (std_encoding != NULL) {
1902 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
1903 Py_XDECREF(codec_info);
1904 }
1905 Py_DECREF(encoding_attr);
1906 }
1907 PyErr_Clear(); /* Not a fatal error if codec isn't available */
1908
1909 if (PySys_SetObject("__stderr__", std) < 0) {
1910 Py_DECREF(std);
1911 goto error;
1912 }
1913 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
1914 Py_DECREF(std);
1915 goto error;
1916 }
1917 Py_DECREF(std);
1918#endif
1919
Victor Stinnera7368ac2017-11-15 18:11:45 -08001920 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10001921
Victor Stinnera7368ac2017-11-15 18:11:45 -08001922error:
1923 res = _Py_INIT_ERR("can't initialize sys standard streams");
1924
1925done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02001926 _Py_ClearStandardStreamEncoding();
Victor Stinner31e99082017-12-20 23:41:38 +01001927
Nick Coghland6009512014-11-20 21:39:37 +10001928 Py_XDECREF(bimod);
1929 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001930 return res;
Nick Coghland6009512014-11-20 21:39:37 +10001931}
1932
1933
Victor Stinner10dc4842015-03-24 12:01:30 +01001934static void
Victor Stinner791da1c2016-03-14 16:53:12 +01001935_Py_FatalError_DumpTracebacks(int fd)
Victor Stinner10dc4842015-03-24 12:01:30 +01001936{
Victor Stinner10dc4842015-03-24 12:01:30 +01001937 fputc('\n', stderr);
1938 fflush(stderr);
1939
1940 /* display the current Python stack */
Victor Stinner861d9ab2016-03-16 22:45:24 +01001941 _Py_DumpTracebackThreads(fd, NULL, NULL);
Victor Stinner10dc4842015-03-24 12:01:30 +01001942}
Victor Stinner791da1c2016-03-14 16:53:12 +01001943
1944/* Print the current exception (if an exception is set) with its traceback,
1945 or display the current Python stack.
1946
1947 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
1948 called on catastrophic cases.
1949
1950 Return 1 if the traceback was displayed, 0 otherwise. */
1951
1952static int
1953_Py_FatalError_PrintExc(int fd)
1954{
1955 PyObject *ferr, *res;
1956 PyObject *exception, *v, *tb;
1957 int has_tb;
1958
Victor Stinner791da1c2016-03-14 16:53:12 +01001959 PyErr_Fetch(&exception, &v, &tb);
1960 if (exception == NULL) {
1961 /* No current exception */
1962 return 0;
1963 }
1964
1965 ferr = _PySys_GetObjectId(&PyId_stderr);
1966 if (ferr == NULL || ferr == Py_None) {
1967 /* sys.stderr is not set yet or set to None,
1968 no need to try to display the exception */
1969 return 0;
1970 }
1971
1972 PyErr_NormalizeException(&exception, &v, &tb);
1973 if (tb == NULL) {
1974 tb = Py_None;
1975 Py_INCREF(tb);
1976 }
1977 PyException_SetTraceback(v, tb);
1978 if (exception == NULL) {
1979 /* PyErr_NormalizeException() failed */
1980 return 0;
1981 }
1982
1983 has_tb = (tb != Py_None);
1984 PyErr_Display(exception, v, tb);
1985 Py_XDECREF(exception);
1986 Py_XDECREF(v);
1987 Py_XDECREF(tb);
1988
1989 /* sys.stderr may be buffered: call sys.stderr.flush() */
Victor Stinner3466bde2016-09-05 18:16:01 -07001990 res = _PyObject_CallMethodId(ferr, &PyId_flush, NULL);
Victor Stinner791da1c2016-03-14 16:53:12 +01001991 if (res == NULL)
1992 PyErr_Clear();
1993 else
1994 Py_DECREF(res);
1995
1996 return has_tb;
1997}
1998
Nick Coghland6009512014-11-20 21:39:37 +10001999/* Print fatal error message and abort */
2000
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002001#ifdef MS_WINDOWS
2002static void
2003fatal_output_debug(const char *msg)
2004{
2005 /* buffer of 256 bytes allocated on the stack */
2006 WCHAR buffer[256 / sizeof(WCHAR)];
2007 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2008 size_t msglen;
2009
2010 OutputDebugStringW(L"Fatal Python error: ");
2011
2012 msglen = strlen(msg);
2013 while (msglen) {
2014 size_t i;
2015
2016 if (buflen > msglen) {
2017 buflen = msglen;
2018 }
2019
2020 /* Convert the message to wchar_t. This uses a simple one-to-one
2021 conversion, assuming that the this error message actually uses
2022 ASCII only. If this ceases to be true, we will have to convert. */
2023 for (i=0; i < buflen; ++i) {
2024 buffer[i] = msg[i];
2025 }
2026 buffer[i] = L'\0';
2027 OutputDebugStringW(buffer);
2028
2029 msg += buflen;
2030 msglen -= buflen;
2031 }
2032 OutputDebugStringW(L"\n");
2033}
2034#endif
2035
Benjamin Petersoncef88b92017-11-25 13:02:55 -08002036static void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002037fatal_error(const char *prefix, const char *msg, int status)
Nick Coghland6009512014-11-20 21:39:37 +10002038{
2039 const int fd = fileno(stderr);
Victor Stinner53345a42015-03-25 01:55:14 +01002040 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002041
2042 if (reentrant) {
2043 /* Py_FatalError() caused a second fatal error.
2044 Example: flush_std_files() raises a recursion error. */
2045 goto exit;
2046 }
2047 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002048
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002049 fprintf(stderr, "Fatal Python error: ");
2050 if (prefix) {
2051 fputs(prefix, stderr);
2052 fputs(": ", stderr);
2053 }
2054 if (msg) {
2055 fputs(msg, stderr);
2056 }
2057 else {
2058 fprintf(stderr, "<message not set>");
2059 }
2060 fputs("\n", stderr);
Nick Coghland6009512014-11-20 21:39:37 +10002061 fflush(stderr); /* it helps in Windows debug build */
Victor Stinner10dc4842015-03-24 12:01:30 +01002062
Victor Stinner3a228ab2018-11-01 00:26:41 +01002063 /* Check if the current thread has a Python thread state
2064 and holds the GIL */
2065 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2066 if (tss_tstate != NULL) {
Victor Stinner50b48572018-11-01 01:51:40 +01002067 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner3a228ab2018-11-01 00:26:41 +01002068 if (tss_tstate != tstate) {
2069 /* The Python thread does not hold the GIL */
2070 tss_tstate = NULL;
2071 }
2072 }
2073 else {
2074 /* Py_FatalError() has been called from a C thread
2075 which has no Python thread state. */
2076 }
2077 int has_tstate_and_gil = (tss_tstate != NULL);
2078
2079 if (has_tstate_and_gil) {
2080 /* If an exception is set, print the exception with its traceback */
2081 if (!_Py_FatalError_PrintExc(fd)) {
2082 /* No exception is set, or an exception is set without traceback */
2083 _Py_FatalError_DumpTracebacks(fd);
2084 }
2085 }
2086 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002087 _Py_FatalError_DumpTracebacks(fd);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002088 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002089
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002090 /* The main purpose of faulthandler is to display the traceback.
2091 This function already did its best to display a traceback.
2092 Disable faulthandler to prevent writing a second traceback
2093 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002094 _PyFaulthandler_Fini();
2095
Victor Stinner791da1c2016-03-14 16:53:12 +01002096 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002097 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002098 /* Flush sys.stdout and sys.stderr */
2099 flush_std_files();
2100 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002101
Nick Coghland6009512014-11-20 21:39:37 +10002102#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002103 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002104#endif /* MS_WINDOWS */
2105
2106exit:
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002107 if (status < 0) {
Victor Stinner53345a42015-03-25 01:55:14 +01002108#if defined(MS_WINDOWS) && defined(_DEBUG)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002109 DebugBreak();
Nick Coghland6009512014-11-20 21:39:37 +10002110#endif
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002111 abort();
2112 }
2113 else {
2114 exit(status);
2115 }
2116}
2117
Victor Stinner19760862017-12-20 01:41:59 +01002118void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002119Py_FatalError(const char *msg)
2120{
2121 fatal_error(NULL, msg, -1);
2122}
2123
Victor Stinner19760862017-12-20 01:41:59 +01002124void _Py_NO_RETURN
Victor Stinnerdfe88472019-03-01 12:14:41 +01002125_Py_ExitInitError(_PyInitError err)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002126{
Victor Stinnerdb719752019-05-01 05:35:33 +02002127 assert(_Py_INIT_FAILED(err));
2128 if (_Py_INIT_IS_EXIT(err)) {
2129#ifdef MS_WINDOWS
2130 ExitProcess(err.exitcode);
2131#else
Victor Stinnerdfe88472019-03-01 12:14:41 +01002132 exit(err.exitcode);
Victor Stinnerdb719752019-05-01 05:35:33 +02002133#endif
Victor Stinnerdfe88472019-03-01 12:14:41 +01002134 }
2135 else {
Victor Stinnerdb719752019-05-01 05:35:33 +02002136 assert(_Py_INIT_IS_ERROR(err));
2137 fatal_error(err._func, err.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002138 }
Nick Coghland6009512014-11-20 21:39:37 +10002139}
2140
2141/* Clean up and exit */
2142
Victor Stinnerd7292b52016-06-17 12:29:00 +02002143# include "pythread.h"
Nick Coghland6009512014-11-20 21:39:37 +10002144
Nick Coghland6009512014-11-20 21:39:37 +10002145/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002146void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002147{
Victor Stinnercaba55b2018-08-03 15:33:52 +02002148 PyInterpreterState *is = _PyInterpreterState_Get();
Marcel Plch776407f2017-12-20 11:17:58 +01002149
Antoine Pitroufc5db952017-12-13 02:29:07 +01002150 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002151 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2152
2153 is->pyexitfunc = func;
2154 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002155}
2156
2157static void
Marcel Plch776407f2017-12-20 11:17:58 +01002158call_py_exitfuncs(PyInterpreterState *istate)
Nick Coghland6009512014-11-20 21:39:37 +10002159{
Marcel Plch776407f2017-12-20 11:17:58 +01002160 if (istate->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002161 return;
2162
Marcel Plch776407f2017-12-20 11:17:58 +01002163 (*istate->pyexitfunc)(istate->pyexitmodule);
Nick Coghland6009512014-11-20 21:39:37 +10002164 PyErr_Clear();
2165}
2166
2167/* Wait until threading._shutdown completes, provided
2168 the threading module was imported in the first place.
2169 The shutdown routine will wait until all non-daemon
2170 "threading" threads have completed. */
2171static void
2172wait_for_thread_shutdown(void)
2173{
Nick Coghland6009512014-11-20 21:39:37 +10002174 _Py_IDENTIFIER(_shutdown);
2175 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002176 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002177 if (threading == NULL) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002178 if (PyErr_Occurred()) {
2179 PyErr_WriteUnraisable(NULL);
2180 }
2181 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002182 return;
2183 }
Victor Stinner3466bde2016-09-05 18:16:01 -07002184 result = _PyObject_CallMethodId(threading, &PyId__shutdown, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10002185 if (result == NULL) {
2186 PyErr_WriteUnraisable(threading);
2187 }
2188 else {
2189 Py_DECREF(result);
2190 }
2191 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002192}
2193
2194#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002195int Py_AtExit(void (*func)(void))
2196{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002197 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002198 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002199 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002200 return 0;
2201}
2202
2203static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002204call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002205{
Victor Stinner8e91c242019-04-24 17:24:01 +02002206 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002207 /* pop last function from the list */
2208 runtime->nexitfuncs--;
2209 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2210 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2211
2212 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002213 }
Nick Coghland6009512014-11-20 21:39:37 +10002214
2215 fflush(stdout);
2216 fflush(stderr);
2217}
2218
Victor Stinnercfc88312018-08-01 16:41:25 +02002219void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002220Py_Exit(int sts)
2221{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002222 if (Py_FinalizeEx() < 0) {
2223 sts = 120;
2224 }
Nick Coghland6009512014-11-20 21:39:37 +10002225
2226 exit(sts);
2227}
2228
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002229static _PyInitError
Victor Stinner43fc3bb2019-05-02 11:54:20 -04002230init_signals(void)
Nick Coghland6009512014-11-20 21:39:37 +10002231{
2232#ifdef SIGPIPE
2233 PyOS_setsig(SIGPIPE, SIG_IGN);
2234#endif
2235#ifdef SIGXFZ
2236 PyOS_setsig(SIGXFZ, SIG_IGN);
2237#endif
2238#ifdef SIGXFSZ
2239 PyOS_setsig(SIGXFSZ, SIG_IGN);
2240#endif
2241 PyOS_InitInterrupts(); /* May imply initsignal() */
2242 if (PyErr_Occurred()) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002243 return _Py_INIT_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002244 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002245 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002246}
2247
2248
2249/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2250 *
2251 * All of the code in this function must only use async-signal-safe functions,
2252 * listed at `man 7 signal` or
2253 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2254 */
2255void
2256_Py_RestoreSignals(void)
2257{
2258#ifdef SIGPIPE
2259 PyOS_setsig(SIGPIPE, SIG_DFL);
2260#endif
2261#ifdef SIGXFZ
2262 PyOS_setsig(SIGXFZ, SIG_DFL);
2263#endif
2264#ifdef SIGXFSZ
2265 PyOS_setsig(SIGXFSZ, SIG_DFL);
2266#endif
2267}
2268
2269
2270/*
2271 * The file descriptor fd is considered ``interactive'' if either
2272 * a) isatty(fd) is TRUE, or
2273 * b) the -i flag was given, and the filename associated with
2274 * the descriptor is NULL or "<stdin>" or "???".
2275 */
2276int
2277Py_FdIsInteractive(FILE *fp, const char *filename)
2278{
2279 if (isatty((int)fileno(fp)))
2280 return 1;
2281 if (!Py_InteractiveFlag)
2282 return 0;
2283 return (filename == NULL) ||
2284 (strcmp(filename, "<stdin>") == 0) ||
2285 (strcmp(filename, "???") == 0);
2286}
2287
2288
Nick Coghland6009512014-11-20 21:39:37 +10002289/* Wrappers around sigaction() or signal(). */
2290
2291PyOS_sighandler_t
2292PyOS_getsig(int sig)
2293{
2294#ifdef HAVE_SIGACTION
2295 struct sigaction context;
2296 if (sigaction(sig, NULL, &context) == -1)
2297 return SIG_ERR;
2298 return context.sa_handler;
2299#else
2300 PyOS_sighandler_t handler;
2301/* Special signal handling for the secure CRT in Visual Studio 2005 */
2302#if defined(_MSC_VER) && _MSC_VER >= 1400
2303 switch (sig) {
2304 /* Only these signals are valid */
2305 case SIGINT:
2306 case SIGILL:
2307 case SIGFPE:
2308 case SIGSEGV:
2309 case SIGTERM:
2310 case SIGBREAK:
2311 case SIGABRT:
2312 break;
2313 /* Don't call signal() with other values or it will assert */
2314 default:
2315 return SIG_ERR;
2316 }
2317#endif /* _MSC_VER && _MSC_VER >= 1400 */
2318 handler = signal(sig, SIG_IGN);
2319 if (handler != SIG_ERR)
2320 signal(sig, handler);
2321 return handler;
2322#endif
2323}
2324
2325/*
2326 * All of the code in this function must only use async-signal-safe functions,
2327 * listed at `man 7 signal` or
2328 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2329 */
2330PyOS_sighandler_t
2331PyOS_setsig(int sig, PyOS_sighandler_t handler)
2332{
2333#ifdef HAVE_SIGACTION
2334 /* Some code in Modules/signalmodule.c depends on sigaction() being
2335 * used here if HAVE_SIGACTION is defined. Fix that if this code
2336 * changes to invalidate that assumption.
2337 */
2338 struct sigaction context, ocontext;
2339 context.sa_handler = handler;
2340 sigemptyset(&context.sa_mask);
2341 context.sa_flags = 0;
2342 if (sigaction(sig, &context, &ocontext) == -1)
2343 return SIG_ERR;
2344 return ocontext.sa_handler;
2345#else
2346 PyOS_sighandler_t oldhandler;
2347 oldhandler = signal(sig, handler);
2348#ifdef HAVE_SIGINTERRUPT
2349 siginterrupt(sig, 1);
2350#endif
2351 return oldhandler;
2352#endif
2353}
2354
2355#ifdef __cplusplus
2356}
2357#endif