blob: 231706d2ab60ba2a98d13923de27f9276aecddc5 [file] [log] [blame]
Nick Coghland6009512014-11-20 21:39:37 +10001/* Python interpreter top-level routines, including init/exit */
2
3#include "Python.h"
4
5#include "Python-ast.h"
Victor Stinner3bb183d2018-11-22 18:38:38 +01006#undef Yield /* undefine macro conflicting with <winbase.h> */
Victor Stinner09532fe2019-05-10 23:39:09 +02007#include "pycore_ceval.h"
Victor Stinner99fcc612019-04-29 13:04:07 +02008#include "pycore_context.h"
Victor Stinner09532fe2019-05-10 23:39:09 +02009#include "pycore_coreconfig.h"
Victor Stinner353933e2018-11-23 13:08:26 +010010#include "pycore_fileutils.h"
Victor Stinner27e2d1f2018-11-01 00:52:28 +010011#include "pycore_hamt.h"
Victor Stinnera1c249c2018-11-01 03:15:58 +010012#include "pycore_pathconfig.h"
Victor Stinner621cebe2018-11-12 16:53:38 +010013#include "pycore_pylifecycle.h"
14#include "pycore_pymem.h"
15#include "pycore_pystate.h"
Nick Coghland6009512014-11-20 21:39:37 +100016#include "grammar.h"
17#include "node.h"
18#include "token.h"
19#include "parsetok.h"
20#include "errcode.h"
21#include "code.h"
22#include "symtable.h"
23#include "ast.h"
24#include "marshal.h"
25#include "osdefs.h"
26#include <locale.h>
27
28#ifdef HAVE_SIGNAL_H
29#include <signal.h>
30#endif
31
32#ifdef MS_WINDOWS
33#include "malloc.h" /* for alloca */
34#endif
35
36#ifdef HAVE_LANGINFO_H
37#include <langinfo.h>
38#endif
39
40#ifdef MS_WINDOWS
41#undef BYTE
42#include "windows.h"
Steve Dower39294992016-08-30 21:22:36 -070043
44extern PyTypeObject PyWindowsConsoleIO_Type;
45#define PyWindowsConsoleIO_Check(op) (PyObject_TypeCheck((op), &PyWindowsConsoleIO_Type))
Nick Coghland6009512014-11-20 21:39:37 +100046#endif
47
48_Py_IDENTIFIER(flush);
49_Py_IDENTIFIER(name);
50_Py_IDENTIFIER(stdin);
51_Py_IDENTIFIER(stdout);
52_Py_IDENTIFIER(stderr);
Eric Snow3f9eee62017-09-15 16:35:20 -060053_Py_IDENTIFIER(threading);
Nick Coghland6009512014-11-20 21:39:37 +100054
55#ifdef __cplusplus
56extern "C" {
57#endif
58
Nick Coghland6009512014-11-20 21:39:37 +100059extern grammar _PyParser_Grammar; /* From graminit.c */
60
61/* Forward */
Victor Stinnerf7e5b562017-11-15 15:48:08 -080062static _PyInitError add_main_module(PyInterpreterState *interp);
Victor Stinner43fc3bb2019-05-02 11:54:20 -040063static _PyInitError init_import_size(void);
Victor Stinner91106cd2017-12-13 12:29:09 +010064static _PyInitError init_sys_streams(PyInterpreterState *interp);
Victor Stinner43fc3bb2019-05-02 11:54:20 -040065static _PyInitError init_signals(void);
Marcel Plch776407f2017-12-20 11:17:58 +010066static void call_py_exitfuncs(PyInterpreterState *);
Nick Coghland6009512014-11-20 21:39:37 +100067static void wait_for_thread_shutdown(void);
Victor Stinner8e91c242019-04-24 17:24:01 +020068static void call_ll_exitfuncs(_PyRuntimeState *runtime);
Nick Coghland6009512014-11-20 21:39:37 +100069
Gregory P. Smith38f11cc2019-02-16 12:57:40 -080070int _Py_UnhandledKeyboardInterrupt = 0;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080071_PyRuntimeState _PyRuntime = _PyRuntimeState_INIT;
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010072static int runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060073
Victor Stinnerf7e5b562017-11-15 15:48:08 -080074_PyInitError
Eric Snow2ebc5ce2017-09-07 23:51:28 -060075_PyRuntime_Initialize(void)
76{
77 /* XXX We only initialize once in the process, which aligns with
78 the static initialization of the former globals now found in
79 _PyRuntime. However, _PyRuntime *should* be initialized with
80 every Py_Initialize() call, but doing so breaks the runtime.
81 This is because the runtime state is not properly finalized
82 currently. */
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010083 if (runtime_initialized) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -080084 return _Py_INIT_OK();
85 }
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010086 runtime_initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080087
88 return _PyRuntimeState_Init(&_PyRuntime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -060089}
90
91void
92_PyRuntime_Finalize(void)
93{
94 _PyRuntimeState_Fini(&_PyRuntime);
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010095 runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060096}
97
98int
99_Py_IsFinalizing(void)
100{
101 return _PyRuntime.finalizing != NULL;
102}
103
Nick Coghland6009512014-11-20 21:39:37 +1000104/* Hack to force loading of object files */
105int (*_PyOS_mystrnicmp_hack)(const char *, const char *, Py_ssize_t) = \
106 PyOS_mystrnicmp; /* Python/pystrcmp.o */
107
108/* PyModule_GetWarningsModule is no longer necessary as of 2.6
109since _warnings is builtin. This API should not be used. */
110PyObject *
111PyModule_GetWarningsModule(void)
112{
113 return PyImport_ImportModule("warnings");
114}
115
Eric Snowc7ec9982017-05-23 23:00:52 -0700116
Eric Snow1abcf672017-05-23 21:46:51 -0700117/* APIs to access the initialization flags
118 *
119 * Can be called prior to Py_Initialize.
120 */
Nick Coghland6009512014-11-20 21:39:37 +1000121
Eric Snow1abcf672017-05-23 21:46:51 -0700122int
123_Py_IsCoreInitialized(void)
124{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600125 return _PyRuntime.core_initialized;
Eric Snow1abcf672017-05-23 21:46:51 -0700126}
Nick Coghland6009512014-11-20 21:39:37 +1000127
128int
129Py_IsInitialized(void)
130{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600131 return _PyRuntime.initialized;
Nick Coghland6009512014-11-20 21:39:37 +1000132}
133
Nick Coghlan6ea41862017-06-11 13:16:15 +1000134
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000135/* Global initializations. Can be undone by Py_FinalizeEx(). Don't
136 call this twice without an intervening Py_FinalizeEx() call. When
Nick Coghland6009512014-11-20 21:39:37 +1000137 initializations fail, a fatal error is issued and the function does
138 not return. On return, the first thread and interpreter state have
139 been created.
140
141 Locking: you must hold the interpreter lock while calling this.
142 (If the lock has not yet been initialized, that's equivalent to
143 having the lock, but you cannot use multiple threads.)
144
145*/
146
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800147static _PyInitError
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400148init_importlib(PyInterpreterState *interp, PyObject *sysmod)
Nick Coghland6009512014-11-20 21:39:37 +1000149{
150 PyObject *importlib;
151 PyObject *impmod;
Nick Coghland6009512014-11-20 21:39:37 +1000152 PyObject *value;
Victor Stinnerc96be812019-05-14 17:34:56 +0200153 int verbose = interp->core_config.verbose;
Nick Coghland6009512014-11-20 21:39:37 +1000154
155 /* Import _importlib through its frozen version, _frozen_importlib. */
156 if (PyImport_ImportFrozenModule("_frozen_importlib") <= 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800157 return _Py_INIT_ERR("can't import _frozen_importlib");
Nick Coghland6009512014-11-20 21:39:37 +1000158 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200159 else if (verbose) {
Nick Coghland6009512014-11-20 21:39:37 +1000160 PySys_FormatStderr("import _frozen_importlib # frozen\n");
161 }
162 importlib = PyImport_AddModule("_frozen_importlib");
163 if (importlib == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800164 return _Py_INIT_ERR("couldn't get _frozen_importlib from sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000165 }
166 interp->importlib = importlib;
167 Py_INCREF(interp->importlib);
168
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300169 interp->import_func = PyDict_GetItemString(interp->builtins, "__import__");
170 if (interp->import_func == NULL)
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800171 return _Py_INIT_ERR("__import__ not found");
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300172 Py_INCREF(interp->import_func);
173
Victor Stinnercd6e6942015-09-18 09:11:57 +0200174 /* Import the _imp module */
Benjamin Petersonc65ef772018-01-29 11:33:57 -0800175 impmod = PyInit__imp();
Nick Coghland6009512014-11-20 21:39:37 +1000176 if (impmod == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800177 return _Py_INIT_ERR("can't import _imp");
Nick Coghland6009512014-11-20 21:39:37 +1000178 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200179 else if (verbose) {
Victor Stinnercd6e6942015-09-18 09:11:57 +0200180 PySys_FormatStderr("import _imp # builtin\n");
Nick Coghland6009512014-11-20 21:39:37 +1000181 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600182 if (_PyImport_SetModuleString("_imp", impmod) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800183 return _Py_INIT_ERR("can't save _imp to sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000184 }
185
Victor Stinnercd6e6942015-09-18 09:11:57 +0200186 /* Install importlib as the implementation of import */
Nick Coghland6009512014-11-20 21:39:37 +1000187 value = PyObject_CallMethod(importlib, "_install", "OO", sysmod, impmod);
188 if (value == NULL) {
189 PyErr_Print();
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800190 return _Py_INIT_ERR("importlib install failed");
Nick Coghland6009512014-11-20 21:39:37 +1000191 }
192 Py_DECREF(value);
193 Py_DECREF(impmod);
194
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800195 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000196}
197
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800198static _PyInitError
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400199init_importlib_external(PyInterpreterState *interp)
Eric Snow1abcf672017-05-23 21:46:51 -0700200{
201 PyObject *value;
202 value = PyObject_CallMethod(interp->importlib,
203 "_install_external_importers", "");
204 if (value == NULL) {
205 PyErr_Print();
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800206 return _Py_INIT_ERR("external importer setup failed");
Eric Snow1abcf672017-05-23 21:46:51 -0700207 }
Stéphane Wirtelab1cb802017-06-08 13:13:20 +0200208 Py_DECREF(value);
Victor Stinner410b85a2019-05-13 17:12:45 +0200209 return _PyImportZip_Init(interp);
Eric Snow1abcf672017-05-23 21:46:51 -0700210}
Nick Coghland6009512014-11-20 21:39:37 +1000211
Nick Coghlan6ea41862017-06-11 13:16:15 +1000212/* Helper functions to better handle the legacy C locale
213 *
214 * The legacy C locale assumes ASCII as the default text encoding, which
215 * causes problems not only for the CPython runtime, but also other
216 * components like GNU readline.
217 *
218 * Accordingly, when the CLI detects it, it attempts to coerce it to a
219 * more capable UTF-8 based alternative as follows:
220 *
221 * if (_Py_LegacyLocaleDetected()) {
222 * _Py_CoerceLegacyLocale();
223 * }
224 *
225 * See the documentation of the PYTHONCOERCECLOCALE setting for more details.
226 *
227 * Locale coercion also impacts the default error handler for the standard
228 * streams: while the usual default is "strict", the default for the legacy
229 * C locale and for any of the coercion target locales is "surrogateescape".
230 */
231
232int
233_Py_LegacyLocaleDetected(void)
234{
235#ifndef MS_WINDOWS
236 /* On non-Windows systems, the C locale is considered a legacy locale */
Nick Coghlaneb817952017-06-18 12:29:42 +1000237 /* XXX (ncoghlan): some platforms (notably Mac OS X) don't appear to treat
238 * the POSIX locale as a simple alias for the C locale, so
239 * we may also want to check for that explicitly.
240 */
Nick Coghlan6ea41862017-06-11 13:16:15 +1000241 const char *ctype_loc = setlocale(LC_CTYPE, NULL);
242 return ctype_loc != NULL && strcmp(ctype_loc, "C") == 0;
243#else
244 /* Windows uses code pages instead of locales, so no locale is legacy */
245 return 0;
246#endif
247}
248
Nick Coghlaneb817952017-06-18 12:29:42 +1000249static const char *_C_LOCALE_WARNING =
250 "Python runtime initialized with LC_CTYPE=C (a locale with default ASCII "
251 "encoding), which may cause Unicode compatibility problems. Using C.UTF-8, "
252 "C.utf8, or UTF-8 (if available) as alternative Unicode-compatible "
253 "locales is recommended.\n";
254
Nick Coghlaneb817952017-06-18 12:29:42 +1000255static void
Victor Stinner43125222019-04-24 18:23:53 +0200256emit_stderr_warning_for_legacy_locale(_PyRuntimeState *runtime)
Nick Coghlaneb817952017-06-18 12:29:42 +1000257{
Victor Stinner43125222019-04-24 18:23:53 +0200258 const _PyPreConfig *preconfig = &runtime->preconfig;
Victor Stinner20004952019-03-26 02:31:11 +0100259 if (preconfig->coerce_c_locale_warn && _Py_LegacyLocaleDetected()) {
Victor Stinnercf215042018-08-29 22:56:06 +0200260 PySys_FormatStderr("%s", _C_LOCALE_WARNING);
Nick Coghlaneb817952017-06-18 12:29:42 +1000261 }
262}
263
Nick Coghlan6ea41862017-06-11 13:16:15 +1000264typedef struct _CandidateLocale {
265 const char *locale_name; /* The locale to try as a coercion target */
266} _LocaleCoercionTarget;
267
268static _LocaleCoercionTarget _TARGET_LOCALES[] = {
269 {"C.UTF-8"},
270 {"C.utf8"},
Nick Coghlan18974c32017-06-30 00:48:14 +1000271 {"UTF-8"},
Nick Coghlan6ea41862017-06-11 13:16:15 +1000272 {NULL}
273};
274
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200275
276int
277_Py_IsLocaleCoercionTarget(const char *ctype_loc)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000278{
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200279 const _LocaleCoercionTarget *target = NULL;
280 for (target = _TARGET_LOCALES; target->locale_name; target++) {
281 if (strcmp(ctype_loc, target->locale_name) == 0) {
282 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000283 }
Victor Stinner124b9eb2018-08-29 01:29:06 +0200284 }
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200285 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000286}
287
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200288
Nick Coghlan6ea41862017-06-11 13:16:15 +1000289#ifdef PY_COERCE_C_LOCALE
Victor Stinner94540602017-12-16 04:54:22 +0100290static const char C_LOCALE_COERCION_WARNING[] =
Nick Coghlan6ea41862017-06-11 13:16:15 +1000291 "Python detected LC_CTYPE=C: LC_CTYPE coerced to %.20s (set another locale "
292 "or PYTHONCOERCECLOCALE=0 to disable this locale coercion behavior).\n";
293
294static void
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200295_coerce_default_locale_settings(int warn, const _LocaleCoercionTarget *target)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000296{
297 const char *newloc = target->locale_name;
298
299 /* Reset locale back to currently configured defaults */
xdegaye1588be62017-11-12 12:45:59 +0100300 _Py_SetLocaleFromEnv(LC_ALL);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000301
302 /* Set the relevant locale environment variable */
303 if (setenv("LC_CTYPE", newloc, 1)) {
304 fprintf(stderr,
305 "Error setting LC_CTYPE, skipping C locale coercion\n");
306 return;
307 }
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200308 if (warn) {
Victor Stinner94540602017-12-16 04:54:22 +0100309 fprintf(stderr, C_LOCALE_COERCION_WARNING, newloc);
Nick Coghlaneb817952017-06-18 12:29:42 +1000310 }
Nick Coghlan6ea41862017-06-11 13:16:15 +1000311
312 /* Reconfigure with the overridden environment variables */
xdegaye1588be62017-11-12 12:45:59 +0100313 _Py_SetLocaleFromEnv(LC_ALL);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000314}
315#endif
316
317void
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200318_Py_CoerceLegacyLocale(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000319{
320#ifdef PY_COERCE_C_LOCALE
Victor Stinner8ea09112018-09-03 17:05:18 +0200321 char *oldloc = NULL;
322
323 oldloc = _PyMem_RawStrdup(setlocale(LC_CTYPE, NULL));
324 if (oldloc == NULL) {
325 return;
326 }
327
Victor Stinner94540602017-12-16 04:54:22 +0100328 const char *locale_override = getenv("LC_ALL");
329 if (locale_override == NULL || *locale_override == '\0') {
330 /* LC_ALL is also not set (or is set to an empty string) */
331 const _LocaleCoercionTarget *target = NULL;
332 for (target = _TARGET_LOCALES; target->locale_name; target++) {
333 const char *new_locale = setlocale(LC_CTYPE,
334 target->locale_name);
335 if (new_locale != NULL) {
Victor Stinnere2510952019-05-02 11:28:57 -0400336#if !defined(_Py_FORCE_UTF8_LOCALE) && defined(HAVE_LANGINFO_H) && defined(CODESET)
Victor Stinner94540602017-12-16 04:54:22 +0100337 /* Also ensure that nl_langinfo works in this locale */
338 char *codeset = nl_langinfo(CODESET);
339 if (!codeset || *codeset == '\0') {
340 /* CODESET is not set or empty, so skip coercion */
341 new_locale = NULL;
342 _Py_SetLocaleFromEnv(LC_CTYPE);
343 continue;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000344 }
Victor Stinner94540602017-12-16 04:54:22 +0100345#endif
346 /* Successfully configured locale, so make it the default */
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200347 _coerce_default_locale_settings(warn, target);
Victor Stinner8ea09112018-09-03 17:05:18 +0200348 goto done;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000349 }
350 }
351 }
352 /* No C locale warning here, as Py_Initialize will emit one later */
Victor Stinner8ea09112018-09-03 17:05:18 +0200353
354 setlocale(LC_CTYPE, oldloc);
355
356done:
357 PyMem_RawFree(oldloc);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000358#endif
359}
360
xdegaye1588be62017-11-12 12:45:59 +0100361/* _Py_SetLocaleFromEnv() is a wrapper around setlocale(category, "") to
362 * isolate the idiosyncrasies of different libc implementations. It reads the
363 * appropriate environment variable and uses its value to select the locale for
364 * 'category'. */
365char *
366_Py_SetLocaleFromEnv(int category)
367{
Victor Stinner353933e2018-11-23 13:08:26 +0100368 char *res;
xdegaye1588be62017-11-12 12:45:59 +0100369#ifdef __ANDROID__
370 const char *locale;
371 const char **pvar;
372#ifdef PY_COERCE_C_LOCALE
373 const char *coerce_c_locale;
374#endif
375 const char *utf8_locale = "C.UTF-8";
376 const char *env_var_set[] = {
377 "LC_ALL",
378 "LC_CTYPE",
379 "LANG",
380 NULL,
381 };
382
383 /* Android setlocale(category, "") doesn't check the environment variables
384 * and incorrectly sets the "C" locale at API 24 and older APIs. We only
385 * check the environment variables listed in env_var_set. */
386 for (pvar=env_var_set; *pvar; pvar++) {
387 locale = getenv(*pvar);
388 if (locale != NULL && *locale != '\0') {
389 if (strcmp(locale, utf8_locale) == 0 ||
390 strcmp(locale, "en_US.UTF-8") == 0) {
391 return setlocale(category, utf8_locale);
392 }
393 return setlocale(category, "C");
394 }
395 }
396
397 /* Android uses UTF-8, so explicitly set the locale to C.UTF-8 if none of
398 * LC_ALL, LC_CTYPE, or LANG is set to a non-empty string.
399 * Quote from POSIX section "8.2 Internationalization Variables":
400 * "4. If the LANG environment variable is not set or is set to the empty
401 * string, the implementation-defined default locale shall be used." */
402
403#ifdef PY_COERCE_C_LOCALE
404 coerce_c_locale = getenv("PYTHONCOERCECLOCALE");
405 if (coerce_c_locale == NULL || strcmp(coerce_c_locale, "0") != 0) {
406 /* Some other ported code may check the environment variables (e.g. in
407 * extension modules), so we make sure that they match the locale
408 * configuration */
409 if (setenv("LC_CTYPE", utf8_locale, 1)) {
410 fprintf(stderr, "Warning: failed setting the LC_CTYPE "
411 "environment variable to %s\n", utf8_locale);
412 }
413 }
414#endif
Victor Stinner353933e2018-11-23 13:08:26 +0100415 res = setlocale(category, utf8_locale);
416#else /* !defined(__ANDROID__) */
417 res = setlocale(category, "");
418#endif
419 _Py_ResetForceASCII();
420 return res;
xdegaye1588be62017-11-12 12:45:59 +0100421}
422
Nick Coghlan6ea41862017-06-11 13:16:15 +1000423
Eric Snow1abcf672017-05-23 21:46:51 -0700424/* Global initializations. Can be undone by Py_Finalize(). Don't
425 call this twice without an intervening Py_Finalize() call.
426
Victor Stinner484f20d2019-03-27 02:04:16 +0100427 Every call to _Py_InitializeFromConfig, Py_Initialize or Py_InitializeEx
Eric Snow1abcf672017-05-23 21:46:51 -0700428 must have a corresponding call to Py_Finalize.
429
430 Locking: you must hold the interpreter lock while calling these APIs.
431 (If the lock has not yet been initialized, that's equivalent to
432 having the lock, but you cannot use multiple threads.)
433
434*/
435
Victor Stinner1dc6e392018-07-25 02:49:17 +0200436static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200437_Py_Initialize_ReconfigureCore(_PyRuntimeState *runtime,
438 PyInterpreterState **interp_p,
Victor Stinner1dc6e392018-07-25 02:49:17 +0200439 const _PyCoreConfig *core_config)
440{
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200441 _PyInitError err;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100442 PyThreadState *tstate = _PyThreadState_GET();
443 if (!tstate) {
444 return _Py_INIT_ERR("failed to read thread state");
445 }
446
447 PyInterpreterState *interp = tstate->interp;
448 if (interp == NULL) {
449 return _Py_INIT_ERR("can't make main interpreter");
450 }
451 *interp_p = interp;
452
Victor Stinner43125222019-04-24 18:23:53 +0200453 _PyCoreConfig_Write(core_config, runtime);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200454
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200455 err = _PyCoreConfig_Copy(&interp->core_config, core_config);
456 if (_Py_INIT_FAILED(err)) {
457 return err;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200458 }
459 core_config = &interp->core_config;
460
461 if (core_config->_install_importlib) {
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200462 err = _PyCoreConfig_SetPathConfig(core_config);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200463 if (_Py_INIT_FAILED(err)) {
464 return err;
465 }
466 }
467 return _Py_INIT_OK();
468}
469
470
Victor Stinner1dc6e392018-07-25 02:49:17 +0200471static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200472pycore_init_runtime(_PyRuntimeState *runtime,
473 const _PyCoreConfig *core_config)
Nick Coghland6009512014-11-20 21:39:37 +1000474{
Victor Stinner43125222019-04-24 18:23:53 +0200475 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +0200476 return _Py_INIT_ERR("main interpreter already initialized");
477 }
Victor Stinnerda273412017-12-15 01:46:02 +0100478
Victor Stinner43125222019-04-24 18:23:53 +0200479 _PyCoreConfig_Write(core_config, runtime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600480
Eric Snow1abcf672017-05-23 21:46:51 -0700481 /* Py_Finalize leaves _Py_Finalizing set in order to help daemon
482 * threads behave a little more gracefully at interpreter shutdown.
483 * We clobber it here so the new interpreter can start with a clean
484 * slate.
485 *
486 * However, this may still lead to misbehaviour if there are daemon
487 * threads still hanging around from a previous Py_Initialize/Finalize
488 * pair :(
489 */
Victor Stinner43125222019-04-24 18:23:53 +0200490 runtime->finalizing = NULL;
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600491
Victor Stinner43125222019-04-24 18:23:53 +0200492 _PyInitError err = _Py_HashRandomization_Init(core_config);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800493 if (_Py_INIT_FAILED(err)) {
494 return err;
495 }
496
Victor Stinner43125222019-04-24 18:23:53 +0200497 err = _PyInterpreterState_Enable(runtime);
Victor Stinnera7368ac2017-11-15 18:11:45 -0800498 if (_Py_INIT_FAILED(err)) {
499 return err;
500 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100501 return _Py_INIT_OK();
502}
Victor Stinnera7368ac2017-11-15 18:11:45 -0800503
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100504
505static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200506pycore_create_interpreter(_PyRuntimeState *runtime,
507 const _PyCoreConfig *core_config,
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100508 PyInterpreterState **interp_p)
509{
510 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnerda273412017-12-15 01:46:02 +0100511 if (interp == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800512 return _Py_INIT_ERR("can't make main interpreter");
Victor Stinnerda273412017-12-15 01:46:02 +0100513 }
Victor Stinner1dc6e392018-07-25 02:49:17 +0200514 *interp_p = interp;
Victor Stinnerda273412017-12-15 01:46:02 +0100515
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200516 _PyInitError err = _PyCoreConfig_Copy(&interp->core_config, core_config);
517 if (_Py_INIT_FAILED(err)) {
518 return err;
Victor Stinnerda273412017-12-15 01:46:02 +0100519 }
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200520 core_config = &interp->core_config;
Nick Coghland6009512014-11-20 21:39:37 +1000521
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200522 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +1000523 if (tstate == NULL)
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800524 return _Py_INIT_ERR("can't make first thread");
Nick Coghland6009512014-11-20 21:39:37 +1000525 (void) PyThreadState_Swap(tstate);
526
Victor Stinner99fcc612019-04-29 13:04:07 +0200527 /* We can't call _PyEval_FiniThreads() in Py_FinalizeEx because
528 destroying the GIL might fail when it is being referenced from
529 another running thread (see issue #9901).
Nick Coghland6009512014-11-20 21:39:37 +1000530 Instead we destroy the previously created GIL here, which ensures
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000531 that we can call Py_Initialize / Py_FinalizeEx multiple times. */
Victor Stinner09532fe2019-05-10 23:39:09 +0200532 _PyEval_FiniThreads(&runtime->ceval);
Victor Stinner2914bb32018-01-29 11:57:45 +0100533
Nick Coghland6009512014-11-20 21:39:37 +1000534 /* Auto-thread-state API */
Victor Stinner43125222019-04-24 18:23:53 +0200535 _PyGILState_Init(runtime, interp, tstate);
Nick Coghland6009512014-11-20 21:39:37 +1000536
Victor Stinner2914bb32018-01-29 11:57:45 +0100537 /* Create the GIL */
538 PyEval_InitThreads();
539
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100540 return _Py_INIT_OK();
541}
Nick Coghland6009512014-11-20 21:39:37 +1000542
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100543
544static _PyInitError
545pycore_init_types(void)
546{
Victor Stinnerab672812019-01-23 15:04:40 +0100547 _PyInitError err = _PyTypes_Init();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100548 if (_Py_INIT_FAILED(err)) {
549 return err;
550 }
551
552 err = _PyUnicode_Init();
553 if (_Py_INIT_FAILED(err)) {
554 return err;
555 }
556
557 if (_PyStructSequence_Init() < 0) {
558 return _Py_INIT_ERR("can't initialize structseq");
559 }
560
561 if (!_PyLong_Init()) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800562 return _Py_INIT_ERR("can't init longs");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100563 }
Nick Coghland6009512014-11-20 21:39:37 +1000564
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100565 err = _PyExc_Init();
566 if (_Py_INIT_FAILED(err)) {
567 return err;
568 }
569
570 if (!_PyFloat_Init()) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800571 return _Py_INIT_ERR("can't init float");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100572 }
Nick Coghland6009512014-11-20 21:39:37 +1000573
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100574 if (!_PyContext_Init()) {
575 return _Py_INIT_ERR("can't init context");
576 }
577 return _Py_INIT_OK();
578}
579
580
581static _PyInitError
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100582pycore_init_builtins(PyInterpreterState *interp)
583{
584 PyObject *bimod = _PyBuiltin_Init();
585 if (bimod == NULL) {
586 return _Py_INIT_ERR("can't initialize builtins modules");
587 }
588 _PyImport_FixupBuiltin(bimod, "builtins", interp->modules);
589
590 interp->builtins = PyModule_GetDict(bimod);
591 if (interp->builtins == NULL) {
592 return _Py_INIT_ERR("can't initialize builtins dict");
593 }
594 Py_INCREF(interp->builtins);
595
596 _PyInitError err = _PyBuiltins_AddExceptions(bimod);
597 if (_Py_INIT_FAILED(err)) {
598 return err;
599 }
600 return _Py_INIT_OK();
601}
602
603
604static _PyInitError
605pycore_init_import_warnings(PyInterpreterState *interp, PyObject *sysmod)
606{
607 _PyInitError err = _PyImport_Init(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800608 if (_Py_INIT_FAILED(err)) {
609 return err;
610 }
Nick Coghland6009512014-11-20 21:39:37 +1000611
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800612 err = _PyImportHooks_Init();
613 if (_Py_INIT_FAILED(err)) {
614 return err;
615 }
Nick Coghland6009512014-11-20 21:39:37 +1000616
617 /* Initialize _warnings. */
Victor Stinner5d862462017-12-19 11:35:58 +0100618 if (_PyWarnings_Init() == NULL) {
Victor Stinner1f151112017-11-23 10:43:14 +0100619 return _Py_INIT_ERR("can't initialize warnings");
620 }
Nick Coghland6009512014-11-20 21:39:37 +1000621
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100622 if (interp->core_config._install_importlib) {
623 err = _PyCoreConfig_SetPathConfig(&interp->core_config);
Victor Stinnerb1147e42018-07-21 02:06:16 +0200624 if (_Py_INIT_FAILED(err)) {
625 return err;
626 }
627 }
628
Eric Snow1abcf672017-05-23 21:46:51 -0700629 /* This call sets up builtin and frozen import support */
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100630 if (interp->core_config._install_importlib) {
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400631 err = init_importlib(interp, sysmod);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800632 if (_Py_INIT_FAILED(err)) {
633 return err;
634 }
Eric Snow1abcf672017-05-23 21:46:51 -0700635 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100636 return _Py_INIT_OK();
637}
638
639
640static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200641_Py_InitializeCore_impl(_PyRuntimeState *runtime,
642 PyInterpreterState **interp_p,
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100643 const _PyCoreConfig *core_config)
644{
645 PyInterpreterState *interp;
646
Victor Stinner43125222019-04-24 18:23:53 +0200647 _PyCoreConfig_Write(core_config, runtime);
Victor Stinner20004952019-03-26 02:31:11 +0100648
Victor Stinner43125222019-04-24 18:23:53 +0200649 _PyInitError err = pycore_init_runtime(runtime, core_config);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100650 if (_Py_INIT_FAILED(err)) {
651 return err;
652 }
653
Victor Stinner43125222019-04-24 18:23:53 +0200654 err = pycore_create_interpreter(runtime, core_config, &interp);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100655 if (_Py_INIT_FAILED(err)) {
656 return err;
657 }
658 core_config = &interp->core_config;
659 *interp_p = interp;
660
661 err = pycore_init_types();
662 if (_Py_INIT_FAILED(err)) {
663 return err;
664 }
665
666 PyObject *sysmod;
Victor Stinner43125222019-04-24 18:23:53 +0200667 err = _PySys_Create(runtime, interp, &sysmod);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100668 if (_Py_INIT_FAILED(err)) {
669 return err;
670 }
671
672 err = pycore_init_builtins(interp);
673 if (_Py_INIT_FAILED(err)) {
674 return err;
675 }
676
677 err = pycore_init_import_warnings(interp, sysmod);
678 if (_Py_INIT_FAILED(err)) {
679 return err;
680 }
Eric Snow1abcf672017-05-23 21:46:51 -0700681
682 /* Only when we get here is the runtime core fully initialized */
Victor Stinner43125222019-04-24 18:23:53 +0200683 runtime->core_initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800684 return _Py_INIT_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700685}
686
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100687
Victor Stinner70005ac2019-05-02 15:25:34 -0400688_PyInitError
689_Py_PreInitializeFromPyArgv(const _PyPreConfig *src_config, const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100690{
691 _PyInitError err;
692
693 err = _PyRuntime_Initialize();
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100694 if (_Py_INIT_FAILED(err)) {
Victor Stinner5ac27a52019-03-27 13:40:14 +0100695 return err;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100696 }
Victor Stinner43125222019-04-24 18:23:53 +0200697 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100698
Victor Stinner43125222019-04-24 18:23:53 +0200699 if (runtime->pre_initialized) {
Victor Stinnerf72346c2019-03-25 17:54:58 +0100700 /* If it's already configured: ignored the new configuration */
Victor Stinner5ac27a52019-03-27 13:40:14 +0100701 return _Py_INIT_OK();
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100702 }
703
Victor Stinnercab5d072019-05-17 19:01:14 +0200704 _PyPreConfig config;
705 _PyPreConfig_Init(&config);
Victor Stinner5ac27a52019-03-27 13:40:14 +0100706
Victor Stinnerf72346c2019-03-25 17:54:58 +0100707 if (src_config) {
Victor Stinner5ac27a52019-03-27 13:40:14 +0100708 if (_PyPreConfig_Copy(&config, src_config) < 0) {
709 err = _Py_INIT_NO_MEMORY();
Victor Stinnerb16b4e42019-05-17 15:20:52 +0200710 return err;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100711 }
712 }
713
Victor Stinner5ac27a52019-03-27 13:40:14 +0100714 err = _PyPreConfig_Read(&config, args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100715 if (_Py_INIT_FAILED(err)) {
Victor Stinnerb16b4e42019-05-17 15:20:52 +0200716 return err;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100717 }
718
Victor Stinner5ac27a52019-03-27 13:40:14 +0100719 err = _PyPreConfig_Write(&config);
Victor Stinnerf72346c2019-03-25 17:54:58 +0100720 if (_Py_INIT_FAILED(err)) {
Victor Stinnerb16b4e42019-05-17 15:20:52 +0200721 return err;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100722 }
723
Victor Stinner43125222019-04-24 18:23:53 +0200724 runtime->pre_initialized = 1;
Victor Stinnerb16b4e42019-05-17 15:20:52 +0200725 return _Py_INIT_OK();
Victor Stinnerf72346c2019-03-25 17:54:58 +0100726}
727
Victor Stinner70005ac2019-05-02 15:25:34 -0400728
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};
Victor Stinner70005ac2019-05-02 15:25:34 -0400733 return _Py_PreInitializeFromPyArgv(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};
Victor Stinner70005ac2019-05-02 15:25:34 -0400741 return _Py_PreInitializeFromPyArgv(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 Stinner70005ac2019-05-02 15:25:34 -0400748 return _Py_PreInitializeFromPyArgv(src_config, NULL);
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100749}
750
751
752_PyInitError
Victor Stinner70005ac2019-05-02 15:25:34 -0400753_Py_PreInitializeFromCoreConfig(const _PyCoreConfig *coreconfig,
754 const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100755{
Victor Stinnercab5d072019-05-17 19:01:14 +0200756 _PyPreConfig config;
757 _PyPreConfig_Init(&config);
Victor Stinner70005ac2019-05-02 15:25:34 -0400758 if (coreconfig != NULL) {
Victor Stinnercab5d072019-05-17 19:01:14 +0200759 _PyPreConfig_GetCoreConfig(&config, coreconfig);
Victor Stinner70005ac2019-05-02 15:25:34 -0400760 }
Victor Stinnercab5d072019-05-17 19:01:14 +0200761
762 if (args == NULL && coreconfig != NULL && coreconfig->parse_argv) {
763 _PyArgv config_args = {
764 .use_bytes_argv = 0,
765 .argc = coreconfig->argv.length,
766 .wchar_argv = coreconfig->argv.items};
767 return _Py_PreInitializeFromPyArgv(&config, &config_args);
768 }
769 else {
770 return _Py_PreInitializeFromPyArgv(&config, args);
771 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100772}
773
774
775static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200776pyinit_coreconfig(_PyRuntimeState *runtime,
777 _PyCoreConfig *config,
Victor Stinner5ac27a52019-03-27 13:40:14 +0100778 const _PyCoreConfig *src_config,
779 const _PyArgv *args,
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100780 PyInterpreterState **interp_p)
781{
Victor Stinner5f38b842019-05-01 02:30:12 +0200782 _PyInitError err;
783
Victor Stinnerd929f182019-03-27 18:28:46 +0100784 if (src_config) {
Victor Stinner1a9f0d82019-05-01 15:22:52 +0200785 err = _PyCoreConfig_Copy(config, src_config);
786 if (_Py_INIT_FAILED(err)) {
787 return err;
Victor Stinnerd929f182019-03-27 18:28:46 +0100788 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100789 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100790
Victor Stinner5f38b842019-05-01 02:30:12 +0200791 if (args) {
792 err = _PyCoreConfig_SetPyArgv(config, args);
793 if (_Py_INIT_FAILED(err)) {
794 return err;
795 }
796 }
797
798 err = _PyCoreConfig_Read(config);
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100799 if (_Py_INIT_FAILED(err)) {
800 return err;
801 }
802
Victor Stinner43125222019-04-24 18:23:53 +0200803 if (!runtime->core_initialized) {
804 return _Py_InitializeCore_impl(runtime, interp_p, config);
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100805 }
806 else {
Victor Stinner43125222019-04-24 18:23:53 +0200807 return _Py_Initialize_ReconfigureCore(runtime, interp_p, config);
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100808 }
809}
810
811
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100812/* Begin interpreter initialization
813 *
814 * On return, the first thread and interpreter state have been created,
815 * but the compiler, signal handling, multithreading and
816 * multiple interpreter support, and codec infrastructure are not yet
817 * available.
818 *
819 * The import system will support builtin and frozen modules only.
820 * The only supported io is writing to sys.stderr
821 *
822 * If any operation invoked by this function fails, a fatal error is
823 * issued and the function does not return.
824 *
825 * Any code invoked from this function should *not* assume it has access
826 * to the Python C API (unless the API is explicitly listed as being
827 * safe to call without calling Py_Initialize first)
828 */
Victor Stinner484f20d2019-03-27 02:04:16 +0100829static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200830_Py_InitializeCore(_PyRuntimeState *runtime,
831 const _PyCoreConfig *src_config,
Victor Stinner5ac27a52019-03-27 13:40:14 +0100832 const _PyArgv *args,
Victor Stinnerf8ba6f52019-03-26 16:58:50 +0100833 PyInterpreterState **interp_p)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200834{
Victor Stinnerd929f182019-03-27 18:28:46 +0100835 _PyInitError err;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200836
Victor Stinner70005ac2019-05-02 15:25:34 -0400837 err = _Py_PreInitializeFromCoreConfig(src_config, args);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200838 if (_Py_INIT_FAILED(err)) {
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100839 return err;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200840 }
841
Victor Stinnercab5d072019-05-17 19:01:14 +0200842 _PyCoreConfig local_config;
843 _PyCoreConfig_Init(&local_config);
Victor Stinner43125222019-04-24 18:23:53 +0200844 err = pyinit_coreconfig(runtime, &local_config, src_config, args, interp_p);
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100845 _PyCoreConfig_Clear(&local_config);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200846 return err;
847}
848
Victor Stinner5ac27a52019-03-27 13:40:14 +0100849
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200850/* Py_Initialize() has already been called: update the main interpreter
851 configuration. Example of bpo-34008: Py_Main() called after
852 Py_Initialize(). */
853static _PyInitError
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100854_Py_ReconfigureMainInterpreter(PyInterpreterState *interp)
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200855{
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100856 _PyCoreConfig *core_config = &interp->core_config;
857
858 PyObject *argv = _PyWstrList_AsList(&core_config->argv);
859 if (argv == NULL) {
860 return _Py_INIT_NO_MEMORY(); \
861 }
862
863 int res = PyDict_SetItemString(interp->sysdict, "argv", argv);
864 Py_DECREF(argv);
865 if (res < 0) {
866 return _Py_INIT_ERR("fail to set sys.argv");
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200867 }
868 return _Py_INIT_OK();
869}
870
Eric Snowc7ec9982017-05-23 23:00:52 -0700871/* Update interpreter state based on supplied configuration settings
872 *
873 * After calling this function, most of the restrictions on the interpreter
874 * are lifted. The only remaining incomplete settings are those related
875 * to the main module (sys.argv[0], __main__ metadata)
876 *
877 * Calling this when the interpreter is not initializing, is already
878 * initialized or without a valid current thread state is a fatal error.
879 * Other errors should be reported as normal Python exceptions with a
880 * non-zero return code.
881 */
Victor Stinner5ac27a52019-03-27 13:40:14 +0100882static _PyInitError
Victor Stinner43125222019-04-24 18:23:53 +0200883_Py_InitializeMainInterpreter(_PyRuntimeState *runtime,
884 PyInterpreterState *interp)
Eric Snow1abcf672017-05-23 21:46:51 -0700885{
Victor Stinner43125222019-04-24 18:23:53 +0200886 if (!runtime->core_initialized) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800887 return _Py_INIT_ERR("runtime core not initialized");
Eric Snowc7ec9982017-05-23 23:00:52 -0700888 }
Eric Snowc7ec9982017-05-23 23:00:52 -0700889
Victor Stinner1dc6e392018-07-25 02:49:17 +0200890 /* Configure the main interpreter */
Victor Stinner1dc6e392018-07-25 02:49:17 +0200891 _PyCoreConfig *core_config = &interp->core_config;
Eric Snowc7ec9982017-05-23 23:00:52 -0700892
Victor Stinner43125222019-04-24 18:23:53 +0200893 if (runtime->initialized) {
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100894 return _Py_ReconfigureMainInterpreter(interp);
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200895 }
896
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200897 if (!core_config->_install_importlib) {
Eric Snow1abcf672017-05-23 21:46:51 -0700898 /* Special mode for freeze_importlib: run with no import system
899 *
900 * This means anything which needs support from extension modules
901 * or pure Python code in the standard library won't work.
902 */
Victor Stinner43125222019-04-24 18:23:53 +0200903 runtime->initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800904 return _Py_INIT_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700905 }
Victor Stinner9316ee42017-11-25 03:17:57 +0100906
Victor Stinner33c377e2017-12-05 15:12:41 +0100907 if (_PyTime_Init() < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800908 return _Py_INIT_ERR("can't initialize time");
Victor Stinner33c377e2017-12-05 15:12:41 +0100909 }
Victor Stinner13019fd2015-04-03 13:10:54 +0200910
Victor Stinner43125222019-04-24 18:23:53 +0200911 if (_PySys_InitMain(runtime, interp) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800912 return _Py_INIT_ERR("can't finish initializing sys");
Victor Stinnerda273412017-12-15 01:46:02 +0100913 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800914
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400915 _PyInitError err = init_importlib_external(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800916 if (_Py_INIT_FAILED(err)) {
917 return err;
918 }
Nick Coghland6009512014-11-20 21:39:37 +1000919
920 /* initialize the faulthandler module */
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200921 err = _PyFaulthandler_Init(core_config->faulthandler);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800922 if (_Py_INIT_FAILED(err)) {
923 return err;
924 }
Nick Coghland6009512014-11-20 21:39:37 +1000925
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400926 err = _PyUnicode_InitEncodings(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800927 if (_Py_INIT_FAILED(err)) {
928 return err;
929 }
Nick Coghland6009512014-11-20 21:39:37 +1000930
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100931 if (core_config->install_signal_handlers) {
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400932 err = init_signals();
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800933 if (_Py_INIT_FAILED(err)) {
934 return err;
935 }
936 }
Nick Coghland6009512014-11-20 21:39:37 +1000937
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200938 if (_PyTraceMalloc_Init(core_config->tracemalloc) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800939 return _Py_INIT_ERR("can't initialize tracemalloc");
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200940 }
Nick Coghland6009512014-11-20 21:39:37 +1000941
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800942 err = add_main_module(interp);
943 if (_Py_INIT_FAILED(err)) {
944 return err;
945 }
Victor Stinnera7368ac2017-11-15 18:11:45 -0800946
Victor Stinner91106cd2017-12-13 12:29:09 +0100947 err = init_sys_streams(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -0800948 if (_Py_INIT_FAILED(err)) {
949 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800950 }
Nick Coghland6009512014-11-20 21:39:37 +1000951
952 /* Initialize warnings. */
Victor Stinner37cd9822018-11-16 11:55:35 +0100953 PyObject *warnoptions = PySys_GetObject("warnoptions");
954 if (warnoptions != NULL && PyList_Size(warnoptions) > 0)
Victor Stinner5d862462017-12-19 11:35:58 +0100955 {
Nick Coghland6009512014-11-20 21:39:37 +1000956 PyObject *warnings_module = PyImport_ImportModule("warnings");
957 if (warnings_module == NULL) {
958 fprintf(stderr, "'import warnings' failed; traceback:\n");
959 PyErr_Print();
960 }
961 Py_XDECREF(warnings_module);
962 }
963
Victor Stinner43125222019-04-24 18:23:53 +0200964 runtime->initialized = 1;
Eric Snow1abcf672017-05-23 21:46:51 -0700965
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200966 if (core_config->site_import) {
Victor Stinner43fc3bb2019-05-02 11:54:20 -0400967 err = init_import_size(); /* Module site */
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800968 if (_Py_INIT_FAILED(err)) {
969 return err;
970 }
971 }
Victor Stinnercf215042018-08-29 22:56:06 +0200972
973#ifndef MS_WINDOWS
Victor Stinner43125222019-04-24 18:23:53 +0200974 emit_stderr_warning_for_legacy_locale(runtime);
Victor Stinnercf215042018-08-29 22:56:06 +0200975#endif
976
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800977 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000978}
979
Victor Stinner9ef5dca2019-05-16 17:38:16 +0200980
981_PyInitError
982_Py_InitializeMain(void)
983{
984 _PyInitError err = _PyRuntime_Initialize();
985 if (_Py_INIT_FAILED(err)) {
986 return err;
987 }
988 _PyRuntimeState *runtime = &_PyRuntime;
989 PyInterpreterState *interp = _PyRuntimeState_GetThreadState(runtime)->interp;
990
991 return _Py_InitializeMainInterpreter(runtime, interp);
992}
993
994
Eric Snowc7ec9982017-05-23 23:00:52 -0700995#undef _INIT_DEBUG_PRINT
996
Victor Stinner5ac27a52019-03-27 13:40:14 +0100997static _PyInitError
998init_python(const _PyCoreConfig *config, const _PyArgv *args)
Eric Snow1abcf672017-05-23 21:46:51 -0700999{
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001000 _PyInitError err;
Victor Stinner43125222019-04-24 18:23:53 +02001001
1002 err = _PyRuntime_Initialize();
1003 if (_Py_INIT_FAILED(err)) {
1004 return err;
1005 }
1006 _PyRuntimeState *runtime = &_PyRuntime;
1007
1008 PyInterpreterState *interp = NULL;
1009 err = _Py_InitializeCore(runtime, config, args, &interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001010 if (_Py_INIT_FAILED(err)) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001011 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001012 }
Victor Stinner1dc6e392018-07-25 02:49:17 +02001013 config = &interp->core_config;
Victor Stinnerbc8ac6b2017-11-30 18:03:55 +01001014
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001015 if (config->_init_main) {
Victor Stinner43125222019-04-24 18:23:53 +02001016 err = _Py_InitializeMainInterpreter(runtime, interp);
Victor Stinner484f20d2019-03-27 02:04:16 +01001017 if (_Py_INIT_FAILED(err)) {
1018 return err;
1019 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001020 }
Victor Stinner484f20d2019-03-27 02:04:16 +01001021
Victor Stinner1dc6e392018-07-25 02:49:17 +02001022 return _Py_INIT_OK();
Eric Snow1abcf672017-05-23 21:46:51 -07001023}
1024
1025
Victor Stinner5ac27a52019-03-27 13:40:14 +01001026_PyInitError
1027_Py_InitializeFromArgs(const _PyCoreConfig *config, int argc, char **argv)
1028{
1029 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
1030 return init_python(config, &args);
1031}
1032
1033
1034_PyInitError
1035_Py_InitializeFromWideArgs(const _PyCoreConfig *config, int argc, wchar_t **argv)
1036{
1037 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
1038 return init_python(config, &args);
1039}
1040
1041
1042_PyInitError
1043_Py_InitializeFromConfig(const _PyCoreConfig *config)
1044{
1045 return init_python(config, NULL);
1046}
1047
1048
Eric Snow1abcf672017-05-23 21:46:51 -07001049void
Nick Coghland6009512014-11-20 21:39:37 +10001050Py_InitializeEx(int install_sigs)
1051{
Victor Stinner43125222019-04-24 18:23:53 +02001052 _PyInitError err;
1053
1054 err = _PyRuntime_Initialize();
1055 if (_Py_INIT_FAILED(err)) {
1056 _Py_ExitInitError(err);
1057 }
1058 _PyRuntimeState *runtime = &_PyRuntime;
1059
1060 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001061 /* bpo-33932: Calling Py_Initialize() twice does nothing. */
1062 return;
1063 }
1064
Victor Stinnercab5d072019-05-17 19:01:14 +02001065 _PyCoreConfig config;
1066 _PyCoreConfig_Init(&config);
Victor Stinner1dc6e392018-07-25 02:49:17 +02001067 config.install_signal_handlers = install_sigs;
1068
Victor Stinner43125222019-04-24 18:23:53 +02001069 err = _Py_InitializeFromConfig(&config);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001070 if (_Py_INIT_FAILED(err)) {
Victor Stinnerdfe88472019-03-01 12:14:41 +01001071 _Py_ExitInitError(err);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001072 }
Nick Coghland6009512014-11-20 21:39:37 +10001073}
1074
1075void
1076Py_Initialize(void)
1077{
1078 Py_InitializeEx(1);
1079}
1080
1081
1082#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001083extern void _Py_dump_counts(FILE*);
Nick Coghland6009512014-11-20 21:39:37 +10001084#endif
1085
1086/* Flush stdout and stderr */
1087
1088static int
1089file_is_closed(PyObject *fobj)
1090{
1091 int r;
1092 PyObject *tmp = PyObject_GetAttrString(fobj, "closed");
1093 if (tmp == NULL) {
1094 PyErr_Clear();
1095 return 0;
1096 }
1097 r = PyObject_IsTrue(tmp);
1098 Py_DECREF(tmp);
1099 if (r < 0)
1100 PyErr_Clear();
1101 return r > 0;
1102}
1103
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001104static int
Nick Coghland6009512014-11-20 21:39:37 +10001105flush_std_files(void)
1106{
1107 PyObject *fout = _PySys_GetObjectId(&PyId_stdout);
1108 PyObject *ferr = _PySys_GetObjectId(&PyId_stderr);
1109 PyObject *tmp;
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001110 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001111
1112 if (fout != NULL && fout != Py_None && !file_is_closed(fout)) {
Victor Stinner3466bde2016-09-05 18:16:01 -07001113 tmp = _PyObject_CallMethodId(fout, &PyId_flush, NULL);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001114 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001115 PyErr_WriteUnraisable(fout);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001116 status = -1;
1117 }
Nick Coghland6009512014-11-20 21:39:37 +10001118 else
1119 Py_DECREF(tmp);
1120 }
1121
1122 if (ferr != NULL && ferr != Py_None && !file_is_closed(ferr)) {
Victor Stinner3466bde2016-09-05 18:16:01 -07001123 tmp = _PyObject_CallMethodId(ferr, &PyId_flush, NULL);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001124 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001125 PyErr_Clear();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001126 status = -1;
1127 }
Nick Coghland6009512014-11-20 21:39:37 +10001128 else
1129 Py_DECREF(tmp);
1130 }
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001131
1132 return status;
Nick Coghland6009512014-11-20 21:39:37 +10001133}
1134
1135/* Undo the effect of Py_Initialize().
1136
1137 Beware: if multiple interpreter and/or thread states exist, these
1138 are not wiped out; only the current thread and interpreter state
1139 are deleted. But since everything else is deleted, those other
1140 interpreter and thread states should no longer be used.
1141
1142 (XXX We should do better, e.g. wipe out all interpreters and
1143 threads.)
1144
1145 Locking: as above.
1146
1147*/
1148
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001149int
1150Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001151{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001152 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001153
Victor Stinner8e91c242019-04-24 17:24:01 +02001154 _PyRuntimeState *runtime = &_PyRuntime;
1155 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001156 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001157 }
Nick Coghland6009512014-11-20 21:39:37 +10001158
Eric Snow842a2f02019-03-15 15:47:51 -06001159 // Wrap up existing "threading"-module-created, non-daemon threads.
Nick Coghland6009512014-11-20 21:39:37 +10001160 wait_for_thread_shutdown();
1161
Eric Snow842a2f02019-03-15 15:47:51 -06001162 // Make any remaining pending calls.
Victor Stinner09532fe2019-05-10 23:39:09 +02001163 _Py_FinishPendingCalls(runtime);
Eric Snow842a2f02019-03-15 15:47:51 -06001164
Victor Stinner8e91c242019-04-24 17:24:01 +02001165 /* Get current thread state and interpreter pointer */
Victor Stinner09532fe2019-05-10 23:39:09 +02001166 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
Victor Stinner8e91c242019-04-24 17:24:01 +02001167 PyInterpreterState *interp = tstate->interp;
1168
Nick Coghland6009512014-11-20 21:39:37 +10001169 /* The interpreter is still entirely intact at this point, and the
1170 * exit funcs may be relying on that. In particular, if some thread
1171 * or exit func is still waiting to do an import, the import machinery
1172 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001173 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001174 * Note that Threading.py uses an exit func to do a join on all the
1175 * threads created thru it, so this also protects pending imports in
1176 * the threads created via Threading.
1177 */
Nick Coghland6009512014-11-20 21:39:37 +10001178
Marcel Plch776407f2017-12-20 11:17:58 +01001179 call_py_exitfuncs(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001180
Victor Stinnerda273412017-12-15 01:46:02 +01001181 /* Copy the core config, PyInterpreterState_Delete() free
1182 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001183#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001184 int show_ref_count = interp->core_config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001185#endif
1186#ifdef Py_TRACE_REFS
Victor Stinnerda273412017-12-15 01:46:02 +01001187 int dump_refs = interp->core_config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001188#endif
1189#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001190 int malloc_stats = interp->core_config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001191#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001192
Nick Coghland6009512014-11-20 21:39:37 +10001193 /* Remaining threads (e.g. daemon threads) will automatically exit
1194 after taking the GIL (in PyEval_RestoreThread()). */
Victor Stinner8e91c242019-04-24 17:24:01 +02001195 runtime->finalizing = tstate;
1196 runtime->initialized = 0;
1197 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001198
Victor Stinnere0deff32015-03-24 13:46:18 +01001199 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001200 if (flush_std_files() < 0) {
1201 status = -1;
1202 }
Nick Coghland6009512014-11-20 21:39:37 +10001203
1204 /* Disable signal handling */
1205 PyOS_FiniInterrupts();
1206
1207 /* Collect garbage. This may call finalizers; it's nice to call these
1208 * before all modules are destroyed.
1209 * XXX If a __del__ or weakref callback is triggered here, and tries to
1210 * XXX import a module, bad things can happen, because Python no
1211 * XXX longer believes it's initialized.
1212 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1213 * XXX is easy to provoke that way. I've also seen, e.g.,
1214 * XXX Exception exceptions.ImportError: 'No module named sha'
1215 * XXX in <function callback at 0x008F5718> ignored
1216 * XXX but I'm unclear on exactly how that one happens. In any case,
1217 * XXX I haven't seen a real-life report of either of these.
1218 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001219 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001220#ifdef COUNT_ALLOCS
1221 /* With COUNT_ALLOCS, it helps to run GC multiple times:
1222 each collection might release some types from the type
1223 list, so they become garbage. */
Łukasz Langafef7e942016-09-09 21:47:46 -07001224 while (_PyGC_CollectIfEnabled() > 0)
Nick Coghland6009512014-11-20 21:39:37 +10001225 /* nothing */;
1226#endif
Eric Snowdae02762017-09-14 00:35:58 -07001227
Nick Coghland6009512014-11-20 21:39:37 +10001228 /* Destroy all modules */
1229 PyImport_Cleanup();
1230
Victor Stinnere0deff32015-03-24 13:46:18 +01001231 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001232 if (flush_std_files() < 0) {
1233 status = -1;
1234 }
Nick Coghland6009512014-11-20 21:39:37 +10001235
1236 /* Collect final garbage. This disposes of cycles created by
1237 * class definitions, for example.
1238 * XXX This is disabled because it caused too many problems. If
1239 * XXX a __del__ or weakref callback triggers here, Python code has
1240 * XXX a hard time running, because even the sys module has been
1241 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1242 * XXX One symptom is a sequence of information-free messages
1243 * XXX coming from threads (if a __del__ or callback is invoked,
1244 * XXX other threads can execute too, and any exception they encounter
1245 * XXX triggers a comedy of errors as subsystem after subsystem
1246 * XXX fails to find what it *expects* to find in sys to help report
1247 * XXX the exception and consequent unexpected failures). I've also
1248 * XXX seen segfaults then, after adding print statements to the
1249 * XXX Python code getting called.
1250 */
1251#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001252 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001253#endif
1254
1255 /* Disable tracemalloc after all Python objects have been destroyed,
1256 so it is possible to use tracemalloc in objects destructor. */
1257 _PyTraceMalloc_Fini();
1258
1259 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1260 _PyImport_Fini();
1261
1262 /* Cleanup typeobject.c's internal caches. */
1263 _PyType_Fini();
1264
1265 /* unload faulthandler module */
1266 _PyFaulthandler_Fini();
1267
1268 /* Debugging stuff */
1269#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001270 _Py_dump_counts(stderr);
Nick Coghland6009512014-11-20 21:39:37 +10001271#endif
1272 /* dump hash stats */
1273 _PyHash_Fini();
1274
Eric Snowdae02762017-09-14 00:35:58 -07001275#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001276 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001277 _PyDebug_PrintTotalRefs();
1278 }
Eric Snowdae02762017-09-14 00:35:58 -07001279#endif
Nick Coghland6009512014-11-20 21:39:37 +10001280
1281#ifdef Py_TRACE_REFS
1282 /* Display all objects still alive -- this can invoke arbitrary
1283 * __repr__ overrides, so requires a mostly-intact interpreter.
1284 * Alas, a lot of stuff may still be alive now that will be cleaned
1285 * up later.
1286 */
Victor Stinnerda273412017-12-15 01:46:02 +01001287 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001288 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001289 }
Nick Coghland6009512014-11-20 21:39:37 +10001290#endif /* Py_TRACE_REFS */
1291
1292 /* Clear interpreter state and all thread states. */
1293 PyInterpreterState_Clear(interp);
1294
1295 /* Now we decref the exception classes. After this point nothing
1296 can raise an exception. That's okay, because each Fini() method
1297 below has been checked to make sure no exceptions are ever
1298 raised.
1299 */
1300
1301 _PyExc_Fini();
1302
1303 /* Sundry finalizers */
1304 PyMethod_Fini();
1305 PyFrame_Fini();
1306 PyCFunction_Fini();
1307 PyTuple_Fini();
1308 PyList_Fini();
1309 PySet_Fini();
1310 PyBytes_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001311 PyLong_Fini();
1312 PyFloat_Fini();
1313 PyDict_Fini();
1314 PySlice_Fini();
Victor Stinner8e91c242019-04-24 17:24:01 +02001315 _PyGC_Fini(runtime);
Eric Snow86ea5812019-05-10 13:29:55 -04001316 _PyWarnings_Fini(interp);
Eric Snow6b4be192017-05-22 21:36:03 -07001317 _Py_HashRandomization_Fini();
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001318 _PyArg_Fini();
Yury Selivanoveb636452016-09-08 22:01:51 -07001319 PyAsyncGen_Fini();
Yury Selivanovf23746a2018-01-22 19:11:18 -05001320 _PyContext_Fini();
Nick Coghland6009512014-11-20 21:39:37 +10001321
1322 /* Cleanup Unicode implementation */
1323 _PyUnicode_Fini();
1324
Victor Stinnerb2457ef2018-08-29 13:25:36 +02001325 _Py_ClearFileSystemEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10001326
1327 /* XXX Still allocated:
1328 - various static ad-hoc pointers to interned strings
1329 - int and float free list blocks
1330 - whatever various modules and libraries allocate
1331 */
1332
1333 PyGrammar_RemoveAccelerators(&_PyParser_Grammar);
1334
1335 /* Cleanup auto-thread-state */
Victor Stinner8e91c242019-04-24 17:24:01 +02001336 _PyGILState_Fini(runtime);
Nick Coghland6009512014-11-20 21:39:37 +10001337
1338 /* Delete current thread. After this, many C API calls become crashy. */
1339 PyThreadState_Swap(NULL);
Victor Stinner8a1be612016-03-14 22:07:55 +01001340
Nick Coghland6009512014-11-20 21:39:37 +10001341 PyInterpreterState_Delete(interp);
1342
1343#ifdef Py_TRACE_REFS
1344 /* Display addresses (& refcnts) of all objects still alive.
1345 * An address can be used to find the repr of the object, printed
1346 * above by _Py_PrintReferences.
1347 */
Victor Stinnerda273412017-12-15 01:46:02 +01001348 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001349 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001350 }
Nick Coghland6009512014-11-20 21:39:37 +10001351#endif /* Py_TRACE_REFS */
Victor Stinner34be807c2016-03-14 12:04:26 +01001352#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001353 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001354 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be807c2016-03-14 12:04:26 +01001355 }
Nick Coghland6009512014-11-20 21:39:37 +10001356#endif
1357
Victor Stinner8e91c242019-04-24 17:24:01 +02001358 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001359
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001360 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001361 return status;
1362}
1363
1364void
1365Py_Finalize(void)
1366{
1367 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001368}
1369
1370/* Create and initialize a new interpreter and thread, and return the
1371 new thread. This requires that Py_Initialize() has been called
1372 first.
1373
1374 Unsuccessful initialization yields a NULL pointer. Note that *no*
1375 exception information is available even in this case -- the
1376 exception information is held in the thread, and there is no
1377 thread.
1378
1379 Locking: as above.
1380
1381*/
1382
Victor Stinnera7368ac2017-11-15 18:11:45 -08001383static _PyInitError
1384new_interpreter(PyThreadState **tstate_p)
Nick Coghland6009512014-11-20 21:39:37 +10001385{
Victor Stinner9316ee42017-11-25 03:17:57 +01001386 _PyInitError err;
Nick Coghland6009512014-11-20 21:39:37 +10001387
Victor Stinner43125222019-04-24 18:23:53 +02001388 err = _PyRuntime_Initialize();
1389 if (_Py_INIT_FAILED(err)) {
1390 return err;
1391 }
1392 _PyRuntimeState *runtime = &_PyRuntime;
1393
1394 if (!runtime->initialized) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001395 return _Py_INIT_ERR("Py_Initialize must be called first");
1396 }
Nick Coghland6009512014-11-20 21:39:37 +10001397
Victor Stinner8a1be612016-03-14 22:07:55 +01001398 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1399 interpreters: disable PyGILState_Check(). */
1400 _PyGILState_check_enabled = 0;
1401
Victor Stinner43125222019-04-24 18:23:53 +02001402 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001403 if (interp == NULL) {
1404 *tstate_p = NULL;
1405 return _Py_INIT_OK();
1406 }
Nick Coghland6009512014-11-20 21:39:37 +10001407
Victor Stinner43125222019-04-24 18:23:53 +02001408 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001409 if (tstate == NULL) {
1410 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001411 *tstate_p = NULL;
1412 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001413 }
1414
Victor Stinner43125222019-04-24 18:23:53 +02001415 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001416
Eric Snow1abcf672017-05-23 21:46:51 -07001417 /* Copy the current interpreter config into the new interpreter */
Victor Stinnerda273412017-12-15 01:46:02 +01001418 _PyCoreConfig *core_config;
Eric Snow1abcf672017-05-23 21:46:51 -07001419 if (save_tstate != NULL) {
Victor Stinnerda273412017-12-15 01:46:02 +01001420 core_config = &save_tstate->interp->core_config;
Eric Snow1abcf672017-05-23 21:46:51 -07001421 } else {
1422 /* No current thread state, copy from the main interpreter */
1423 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinnerda273412017-12-15 01:46:02 +01001424 core_config = &main_interp->core_config;
Victor Stinnerda273412017-12-15 01:46:02 +01001425 }
1426
Victor Stinner1a9f0d82019-05-01 15:22:52 +02001427 err = _PyCoreConfig_Copy(&interp->core_config, core_config);
1428 if (_Py_INIT_FAILED(err)) {
1429 return err;
Victor Stinnerda273412017-12-15 01:46:02 +01001430 }
Victor Stinnerd19d8d52018-07-24 13:55:48 +02001431 core_config = &interp->core_config;
Eric Snow1abcf672017-05-23 21:46:51 -07001432
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001433 err = _PyExc_Init();
1434 if (_Py_INIT_FAILED(err)) {
1435 return err;
1436 }
1437
Nick Coghland6009512014-11-20 21:39:37 +10001438 /* XXX The following is lax in error checking */
Eric Snowd393c1b2017-09-14 12:18:12 -06001439 PyObject *modules = PyDict_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001440 if (modules == NULL) {
1441 return _Py_INIT_ERR("can't make modules dictionary");
1442 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001443 interp->modules = modules;
Nick Coghland6009512014-11-20 21:39:37 +10001444
Victor Stinner43125222019-04-24 18:23:53 +02001445 PyObject *sysmod = _PyImport_FindBuiltin("sys", modules);
Eric Snowd393c1b2017-09-14 12:18:12 -06001446 if (sysmod != NULL) {
1447 interp->sysdict = PyModule_GetDict(sysmod);
Victor Stinner43125222019-04-24 18:23:53 +02001448 if (interp->sysdict == NULL) {
Eric Snowd393c1b2017-09-14 12:18:12 -06001449 goto handle_error;
Victor Stinner43125222019-04-24 18:23:53 +02001450 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001451 Py_INCREF(interp->sysdict);
1452 PyDict_SetItemString(interp->sysdict, "modules", modules);
Victor Stinner43125222019-04-24 18:23:53 +02001453 if (_PySys_InitMain(runtime, interp) < 0) {
Victor Stinnerab672812019-01-23 15:04:40 +01001454 return _Py_INIT_ERR("can't finish initializing sys");
1455 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001456 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001457 else if (PyErr_Occurred()) {
1458 goto handle_error;
1459 }
Eric Snowd393c1b2017-09-14 12:18:12 -06001460
Victor Stinner43125222019-04-24 18:23:53 +02001461 PyObject *bimod = _PyImport_FindBuiltin("builtins", modules);
Nick Coghland6009512014-11-20 21:39:37 +10001462 if (bimod != NULL) {
1463 interp->builtins = PyModule_GetDict(bimod);
1464 if (interp->builtins == NULL)
1465 goto handle_error;
1466 Py_INCREF(interp->builtins);
1467 }
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02001468 else if (PyErr_Occurred()) {
1469 goto handle_error;
1470 }
Nick Coghland6009512014-11-20 21:39:37 +10001471
Nick Coghland6009512014-11-20 21:39:37 +10001472 if (bimod != NULL && sysmod != NULL) {
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001473 err = _PyBuiltins_AddExceptions(bimod);
1474 if (_Py_INIT_FAILED(err)) {
1475 return err;
1476 }
Nick Coghland6009512014-11-20 21:39:37 +10001477
Victor Stinnerab672812019-01-23 15:04:40 +01001478 err = _PySys_SetPreliminaryStderr(interp->sysdict);
1479 if (_Py_INIT_FAILED(err)) {
1480 return err;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001481 }
Nick Coghland6009512014-11-20 21:39:37 +10001482
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001483 err = _PyImportHooks_Init();
1484 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001485 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001486 }
Nick Coghland6009512014-11-20 21:39:37 +10001487
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001488 err = init_importlib(interp, sysmod);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001489 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001490 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001491 }
Nick Coghland6009512014-11-20 21:39:37 +10001492
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001493 err = init_importlib_external(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001494 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001495 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001496 }
Nick Coghland6009512014-11-20 21:39:37 +10001497
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001498 err = _PyUnicode_InitEncodings(interp);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001499 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001500 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001501 }
1502
Victor Stinner91106cd2017-12-13 12:29:09 +01001503 err = init_sys_streams(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001504 if (_Py_INIT_FAILED(err)) {
1505 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001506 }
1507
1508 err = add_main_module(interp);
1509 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001510 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001511 }
1512
Victor Stinnerd19d8d52018-07-24 13:55:48 +02001513 if (core_config->site_import) {
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001514 err = init_import_size();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001515 if (_Py_INIT_FAILED(err)) {
Victor Stinnera7368ac2017-11-15 18:11:45 -08001516 return err;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001517 }
1518 }
Nick Coghland6009512014-11-20 21:39:37 +10001519 }
1520
Victor Stinnera7368ac2017-11-15 18:11:45 -08001521 if (PyErr_Occurred()) {
1522 goto handle_error;
1523 }
Nick Coghland6009512014-11-20 21:39:37 +10001524
Victor Stinnera7368ac2017-11-15 18:11:45 -08001525 *tstate_p = tstate;
1526 return _Py_INIT_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001527
Nick Coghland6009512014-11-20 21:39:37 +10001528handle_error:
1529 /* Oops, it didn't work. Undo it all. */
1530
1531 PyErr_PrintEx(0);
1532 PyThreadState_Clear(tstate);
1533 PyThreadState_Swap(save_tstate);
1534 PyThreadState_Delete(tstate);
1535 PyInterpreterState_Delete(interp);
1536
Victor Stinnera7368ac2017-11-15 18:11:45 -08001537 *tstate_p = NULL;
1538 return _Py_INIT_OK();
1539}
1540
1541PyThreadState *
1542Py_NewInterpreter(void)
1543{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001544 PyThreadState *tstate = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001545 _PyInitError err = new_interpreter(&tstate);
1546 if (_Py_INIT_FAILED(err)) {
Victor Stinnerdfe88472019-03-01 12:14:41 +01001547 _Py_ExitInitError(err);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001548 }
1549 return tstate;
1550
Nick Coghland6009512014-11-20 21:39:37 +10001551}
1552
1553/* Delete an interpreter and its last thread. This requires that the
1554 given thread state is current, that the thread has no remaining
1555 frames, and that it is its interpreter's only remaining thread.
1556 It is a fatal error to violate these constraints.
1557
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001558 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001559 everything, regardless.)
1560
1561 Locking: as above.
1562
1563*/
1564
1565void
1566Py_EndInterpreter(PyThreadState *tstate)
1567{
1568 PyInterpreterState *interp = tstate->interp;
1569
Victor Stinner50b48572018-11-01 01:51:40 +01001570 if (tstate != _PyThreadState_GET())
Nick Coghland6009512014-11-20 21:39:37 +10001571 Py_FatalError("Py_EndInterpreter: thread is not current");
1572 if (tstate->frame != NULL)
1573 Py_FatalError("Py_EndInterpreter: thread still has a frame");
Eric Snow5be45a62019-03-08 22:47:07 -07001574 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001575
Eric Snow842a2f02019-03-15 15:47:51 -06001576 // Wrap up existing "threading"-module-created, non-daemon threads.
Nick Coghland6009512014-11-20 21:39:37 +10001577 wait_for_thread_shutdown();
1578
Marcel Plch776407f2017-12-20 11:17:58 +01001579 call_py_exitfuncs(interp);
1580
Nick Coghland6009512014-11-20 21:39:37 +10001581 if (tstate != interp->tstate_head || tstate->next != NULL)
1582 Py_FatalError("Py_EndInterpreter: not the last thread");
1583
1584 PyImport_Cleanup();
1585 PyInterpreterState_Clear(interp);
1586 PyThreadState_Swap(NULL);
1587 PyInterpreterState_Delete(interp);
1588}
1589
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001590/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001591
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001592static _PyInitError
1593add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001594{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001595 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001596 m = PyImport_AddModule("__main__");
1597 if (m == NULL)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001598 return _Py_INIT_ERR("can't create __main__ module");
1599
Nick Coghland6009512014-11-20 21:39:37 +10001600 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001601 ann_dict = PyDict_New();
1602 if ((ann_dict == NULL) ||
1603 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001604 return _Py_INIT_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001605 }
1606 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001607
Nick Coghland6009512014-11-20 21:39:37 +10001608 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1609 PyObject *bimod = PyImport_ImportModule("builtins");
1610 if (bimod == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001611 return _Py_INIT_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001612 }
1613 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001614 return _Py_INIT_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001615 }
1616 Py_DECREF(bimod);
1617 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001618
Nick Coghland6009512014-11-20 21:39:37 +10001619 /* Main is a little special - imp.is_builtin("__main__") will return
1620 * False, but BuiltinImporter is still the most appropriate initial
1621 * setting for its __loader__ attribute. A more suitable value will
1622 * be set if __main__ gets further initialized later in the startup
1623 * process.
1624 */
1625 loader = PyDict_GetItemString(d, "__loader__");
1626 if (loader == NULL || loader == Py_None) {
1627 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1628 "BuiltinImporter");
1629 if (loader == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001630 return _Py_INIT_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001631 }
1632 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001633 return _Py_INIT_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001634 }
1635 Py_DECREF(loader);
1636 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001637 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001638}
1639
Nick Coghland6009512014-11-20 21:39:37 +10001640/* Import the site module (not into __main__ though) */
1641
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001642static _PyInitError
Victor Stinner43fc3bb2019-05-02 11:54:20 -04001643init_import_size(void)
Nick Coghland6009512014-11-20 21:39:37 +10001644{
1645 PyObject *m;
1646 m = PyImport_ImportModule("site");
1647 if (m == NULL) {
Victor Stinnerdb719752019-05-01 05:35:33 +02001648 return _Py_INIT_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001649 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001650 Py_DECREF(m);
1651 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001652}
1653
Victor Stinner874dbe82015-09-04 17:29:57 +02001654/* Check if a file descriptor is valid or not.
1655 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1656static int
1657is_valid_fd(int fd)
1658{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001659/* dup() is faster than fstat(): fstat() can require input/output operations,
1660 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1661 startup. Problem: dup() doesn't check if the file descriptor is valid on
1662 some platforms.
1663
1664 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1665 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1666 EBADF. FreeBSD has similar issue (bpo-32849).
1667
1668 Only use dup() on platforms where dup() is enough to detect invalid FD in
1669 corner cases: on Linux and Windows (bpo-32849). */
1670#if defined(__linux__) || defined(MS_WINDOWS)
1671 if (fd < 0) {
1672 return 0;
1673 }
1674 int fd2;
1675
1676 _Py_BEGIN_SUPPRESS_IPH
1677 fd2 = dup(fd);
1678 if (fd2 >= 0) {
1679 close(fd2);
1680 }
1681 _Py_END_SUPPRESS_IPH
1682
1683 return (fd2 >= 0);
1684#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001685 struct stat st;
1686 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001687#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001688}
1689
1690/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001691static PyObject*
Victor Stinnerfbca9082018-08-30 00:50:45 +02001692create_stdio(const _PyCoreConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001693 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001694 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001695{
1696 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1697 const char* mode;
1698 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001699 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001700 int buffering, isatty;
1701 _Py_IDENTIFIER(open);
1702 _Py_IDENTIFIER(isatty);
1703 _Py_IDENTIFIER(TextIOWrapper);
1704 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001705 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001706
Victor Stinner874dbe82015-09-04 17:29:57 +02001707 if (!is_valid_fd(fd))
1708 Py_RETURN_NONE;
1709
Nick Coghland6009512014-11-20 21:39:37 +10001710 /* stdin is always opened in buffered mode, first because it shouldn't
1711 make a difference in common use cases, second because TextIOWrapper
1712 depends on the presence of a read1() method which only exists on
1713 buffered streams.
1714 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001715 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001716 buffering = 0;
1717 else
1718 buffering = -1;
1719 if (write_mode)
1720 mode = "wb";
1721 else
1722 mode = "rb";
1723 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOi",
1724 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001725 Py_None, Py_None, /* encoding, errors */
1726 Py_None, 0); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001727 if (buf == NULL)
1728 goto error;
1729
1730 if (buffering) {
1731 _Py_IDENTIFIER(raw);
1732 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1733 if (raw == NULL)
1734 goto error;
1735 }
1736 else {
1737 raw = buf;
1738 Py_INCREF(raw);
1739 }
1740
Steve Dower39294992016-08-30 21:22:36 -07001741#ifdef MS_WINDOWS
1742 /* Windows console IO is always UTF-8 encoded */
1743 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001744 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001745#endif
1746
Nick Coghland6009512014-11-20 21:39:37 +10001747 text = PyUnicode_FromString(name);
1748 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1749 goto error;
Victor Stinner3466bde2016-09-05 18:16:01 -07001750 res = _PyObject_CallMethodId(raw, &PyId_isatty, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10001751 if (res == NULL)
1752 goto error;
1753 isatty = PyObject_IsTrue(res);
1754 Py_DECREF(res);
1755 if (isatty == -1)
1756 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001757 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001758 write_through = Py_True;
1759 else
1760 write_through = Py_False;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001761 if (isatty && buffered_stdio)
Nick Coghland6009512014-11-20 21:39:37 +10001762 line_buffering = Py_True;
1763 else
1764 line_buffering = Py_False;
1765
1766 Py_CLEAR(raw);
1767 Py_CLEAR(text);
1768
1769#ifdef MS_WINDOWS
1770 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1771 newlines to "\n".
1772 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1773 newline = NULL;
1774#else
1775 /* sys.stdin: split lines at "\n".
1776 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1777 newline = "\n";
1778#endif
1779
Victor Stinner709d23d2019-05-02 14:56:30 -04001780 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1781 if (encoding_str == NULL) {
1782 Py_CLEAR(buf);
1783 goto error;
1784 }
1785
1786 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1787 if (errors_str == NULL) {
1788 Py_CLEAR(buf);
1789 Py_CLEAR(encoding_str);
1790 goto error;
1791 }
1792
1793 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1794 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001795 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001796 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001797 Py_CLEAR(encoding_str);
1798 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001799 if (stream == NULL)
1800 goto error;
1801
1802 if (write_mode)
1803 mode = "w";
1804 else
1805 mode = "r";
1806 text = PyUnicode_FromString(mode);
1807 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1808 goto error;
1809 Py_CLEAR(text);
1810 return stream;
1811
1812error:
1813 Py_XDECREF(buf);
1814 Py_XDECREF(stream);
1815 Py_XDECREF(text);
1816 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001817
Victor Stinner874dbe82015-09-04 17:29:57 +02001818 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1819 /* Issue #24891: the file descriptor was closed after the first
1820 is_valid_fd() check was called. Ignore the OSError and set the
1821 stream to None. */
1822 PyErr_Clear();
1823 Py_RETURN_NONE;
1824 }
1825 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001826}
1827
1828/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinnera7368ac2017-11-15 18:11:45 -08001829static _PyInitError
Victor Stinner91106cd2017-12-13 12:29:09 +01001830init_sys_streams(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001831{
1832 PyObject *iomod = NULL, *wrapper;
1833 PyObject *bimod = NULL;
1834 PyObject *m;
1835 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001836 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001837 PyObject * encoding_attr;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001838 _PyInitError res = _Py_INIT_OK();
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001839 _PyCoreConfig *config = &interp->core_config;
1840
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001841 /* Check that stdin is not a directory
1842 Using shell redirection, you can redirect stdin to a directory,
1843 crashing the Python interpreter. Catch this common mistake here
1844 and output a useful error message. Note that under MS Windows,
1845 the shell already prevents that. */
1846#ifndef MS_WINDOWS
1847 struct _Py_stat_struct sb;
1848 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1849 S_ISDIR(sb.st_mode)) {
Victor Stinnerdb719752019-05-01 05:35:33 +02001850 return _Py_INIT_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001851 }
1852#endif
1853
Nick Coghland6009512014-11-20 21:39:37 +10001854 /* Hack to avoid a nasty recursion issue when Python is invoked
1855 in verbose mode: pre-import the Latin-1 and UTF-8 codecs */
1856 if ((m = PyImport_ImportModule("encodings.utf_8")) == NULL) {
1857 goto error;
1858 }
1859 Py_DECREF(m);
1860
1861 if (!(m = PyImport_ImportModule("encodings.latin_1"))) {
1862 goto error;
1863 }
1864 Py_DECREF(m);
1865
1866 if (!(bimod = PyImport_ImportModule("builtins"))) {
1867 goto error;
1868 }
1869
1870 if (!(iomod = PyImport_ImportModule("io"))) {
1871 goto error;
1872 }
1873 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1874 goto error;
1875 }
1876
1877 /* Set builtins.open */
1878 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1879 Py_DECREF(wrapper);
1880 goto error;
1881 }
1882 Py_DECREF(wrapper);
1883
Nick Coghland6009512014-11-20 21:39:37 +10001884 /* Set sys.stdin */
1885 fd = fileno(stdin);
1886 /* Under some conditions stdin, stdout and stderr may not be connected
1887 * and fileno() may point to an invalid file descriptor. For example
1888 * GUI apps don't have valid standard streams by default.
1889 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001890 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001891 config->stdio_encoding,
1892 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001893 if (std == NULL)
1894 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001895 PySys_SetObject("__stdin__", std);
1896 _PySys_SetObjectId(&PyId_stdin, std);
1897 Py_DECREF(std);
1898
1899 /* Set sys.stdout */
1900 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001901 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001902 config->stdio_encoding,
1903 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001904 if (std == NULL)
1905 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001906 PySys_SetObject("__stdout__", std);
1907 _PySys_SetObjectId(&PyId_stdout, std);
1908 Py_DECREF(std);
1909
1910#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
1911 /* Set sys.stderr, replaces the preliminary stderr */
1912 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001913 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001914 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04001915 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02001916 if (std == NULL)
1917 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001918
1919 /* Same as hack above, pre-import stderr's codec to avoid recursion
1920 when import.c tries to write to stderr in verbose mode. */
1921 encoding_attr = PyObject_GetAttrString(std, "encoding");
1922 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001923 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10001924 if (std_encoding != NULL) {
1925 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
1926 Py_XDECREF(codec_info);
1927 }
1928 Py_DECREF(encoding_attr);
1929 }
1930 PyErr_Clear(); /* Not a fatal error if codec isn't available */
1931
1932 if (PySys_SetObject("__stderr__", std) < 0) {
1933 Py_DECREF(std);
1934 goto error;
1935 }
1936 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
1937 Py_DECREF(std);
1938 goto error;
1939 }
1940 Py_DECREF(std);
1941#endif
1942
Victor Stinnera7368ac2017-11-15 18:11:45 -08001943 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10001944
Victor Stinnera7368ac2017-11-15 18:11:45 -08001945error:
1946 res = _Py_INIT_ERR("can't initialize sys standard streams");
1947
1948done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02001949 _Py_ClearStandardStreamEncoding();
Victor Stinner31e99082017-12-20 23:41:38 +01001950
Nick Coghland6009512014-11-20 21:39:37 +10001951 Py_XDECREF(bimod);
1952 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001953 return res;
Nick Coghland6009512014-11-20 21:39:37 +10001954}
1955
1956
Victor Stinner10dc4842015-03-24 12:01:30 +01001957static void
Victor Stinner791da1c2016-03-14 16:53:12 +01001958_Py_FatalError_DumpTracebacks(int fd)
Victor Stinner10dc4842015-03-24 12:01:30 +01001959{
Victor Stinner10dc4842015-03-24 12:01:30 +01001960 fputc('\n', stderr);
1961 fflush(stderr);
1962
1963 /* display the current Python stack */
Victor Stinner861d9ab2016-03-16 22:45:24 +01001964 _Py_DumpTracebackThreads(fd, NULL, NULL);
Victor Stinner10dc4842015-03-24 12:01:30 +01001965}
Victor Stinner791da1c2016-03-14 16:53:12 +01001966
1967/* Print the current exception (if an exception is set) with its traceback,
1968 or display the current Python stack.
1969
1970 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
1971 called on catastrophic cases.
1972
1973 Return 1 if the traceback was displayed, 0 otherwise. */
1974
1975static int
1976_Py_FatalError_PrintExc(int fd)
1977{
1978 PyObject *ferr, *res;
1979 PyObject *exception, *v, *tb;
1980 int has_tb;
1981
Victor Stinner791da1c2016-03-14 16:53:12 +01001982 PyErr_Fetch(&exception, &v, &tb);
1983 if (exception == NULL) {
1984 /* No current exception */
1985 return 0;
1986 }
1987
1988 ferr = _PySys_GetObjectId(&PyId_stderr);
1989 if (ferr == NULL || ferr == Py_None) {
1990 /* sys.stderr is not set yet or set to None,
1991 no need to try to display the exception */
1992 return 0;
1993 }
1994
1995 PyErr_NormalizeException(&exception, &v, &tb);
1996 if (tb == NULL) {
1997 tb = Py_None;
1998 Py_INCREF(tb);
1999 }
2000 PyException_SetTraceback(v, tb);
2001 if (exception == NULL) {
2002 /* PyErr_NormalizeException() failed */
2003 return 0;
2004 }
2005
2006 has_tb = (tb != Py_None);
2007 PyErr_Display(exception, v, tb);
2008 Py_XDECREF(exception);
2009 Py_XDECREF(v);
2010 Py_XDECREF(tb);
2011
2012 /* sys.stderr may be buffered: call sys.stderr.flush() */
Victor Stinner3466bde2016-09-05 18:16:01 -07002013 res = _PyObject_CallMethodId(ferr, &PyId_flush, NULL);
Victor Stinner791da1c2016-03-14 16:53:12 +01002014 if (res == NULL)
2015 PyErr_Clear();
2016 else
2017 Py_DECREF(res);
2018
2019 return has_tb;
2020}
2021
Nick Coghland6009512014-11-20 21:39:37 +10002022/* Print fatal error message and abort */
2023
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002024#ifdef MS_WINDOWS
2025static void
2026fatal_output_debug(const char *msg)
2027{
2028 /* buffer of 256 bytes allocated on the stack */
2029 WCHAR buffer[256 / sizeof(WCHAR)];
2030 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2031 size_t msglen;
2032
2033 OutputDebugStringW(L"Fatal Python error: ");
2034
2035 msglen = strlen(msg);
2036 while (msglen) {
2037 size_t i;
2038
2039 if (buflen > msglen) {
2040 buflen = msglen;
2041 }
2042
2043 /* Convert the message to wchar_t. This uses a simple one-to-one
2044 conversion, assuming that the this error message actually uses
2045 ASCII only. If this ceases to be true, we will have to convert. */
2046 for (i=0; i < buflen; ++i) {
2047 buffer[i] = msg[i];
2048 }
2049 buffer[i] = L'\0';
2050 OutputDebugStringW(buffer);
2051
2052 msg += buflen;
2053 msglen -= buflen;
2054 }
2055 OutputDebugStringW(L"\n");
2056}
2057#endif
2058
Benjamin Petersoncef88b92017-11-25 13:02:55 -08002059static void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002060fatal_error(const char *prefix, const char *msg, int status)
Nick Coghland6009512014-11-20 21:39:37 +10002061{
2062 const int fd = fileno(stderr);
Victor Stinner53345a42015-03-25 01:55:14 +01002063 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002064
2065 if (reentrant) {
2066 /* Py_FatalError() caused a second fatal error.
2067 Example: flush_std_files() raises a recursion error. */
2068 goto exit;
2069 }
2070 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002071
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002072 fprintf(stderr, "Fatal Python error: ");
2073 if (prefix) {
2074 fputs(prefix, stderr);
2075 fputs(": ", stderr);
2076 }
2077 if (msg) {
2078 fputs(msg, stderr);
2079 }
2080 else {
2081 fprintf(stderr, "<message not set>");
2082 }
2083 fputs("\n", stderr);
Nick Coghland6009512014-11-20 21:39:37 +10002084 fflush(stderr); /* it helps in Windows debug build */
Victor Stinner10dc4842015-03-24 12:01:30 +01002085
Victor Stinner3a228ab2018-11-01 00:26:41 +01002086 /* Check if the current thread has a Python thread state
2087 and holds the GIL */
2088 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2089 if (tss_tstate != NULL) {
Victor Stinner50b48572018-11-01 01:51:40 +01002090 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner3a228ab2018-11-01 00:26:41 +01002091 if (tss_tstate != tstate) {
2092 /* The Python thread does not hold the GIL */
2093 tss_tstate = NULL;
2094 }
2095 }
2096 else {
2097 /* Py_FatalError() has been called from a C thread
2098 which has no Python thread state. */
2099 }
2100 int has_tstate_and_gil = (tss_tstate != NULL);
2101
2102 if (has_tstate_and_gil) {
2103 /* If an exception is set, print the exception with its traceback */
2104 if (!_Py_FatalError_PrintExc(fd)) {
2105 /* No exception is set, or an exception is set without traceback */
2106 _Py_FatalError_DumpTracebacks(fd);
2107 }
2108 }
2109 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002110 _Py_FatalError_DumpTracebacks(fd);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002111 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002112
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002113 /* The main purpose of faulthandler is to display the traceback.
2114 This function already did its best to display a traceback.
2115 Disable faulthandler to prevent writing a second traceback
2116 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002117 _PyFaulthandler_Fini();
2118
Victor Stinner791da1c2016-03-14 16:53:12 +01002119 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002120 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002121 /* Flush sys.stdout and sys.stderr */
2122 flush_std_files();
2123 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002124
Nick Coghland6009512014-11-20 21:39:37 +10002125#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002126 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002127#endif /* MS_WINDOWS */
2128
2129exit:
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002130 if (status < 0) {
Victor Stinner53345a42015-03-25 01:55:14 +01002131#if defined(MS_WINDOWS) && defined(_DEBUG)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002132 DebugBreak();
Nick Coghland6009512014-11-20 21:39:37 +10002133#endif
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002134 abort();
2135 }
2136 else {
2137 exit(status);
2138 }
2139}
2140
Victor Stinner19760862017-12-20 01:41:59 +01002141void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002142Py_FatalError(const char *msg)
2143{
2144 fatal_error(NULL, msg, -1);
2145}
2146
Victor Stinner19760862017-12-20 01:41:59 +01002147void _Py_NO_RETURN
Victor Stinnerdfe88472019-03-01 12:14:41 +01002148_Py_ExitInitError(_PyInitError err)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002149{
Victor Stinnerdb719752019-05-01 05:35:33 +02002150 if (_Py_INIT_IS_EXIT(err)) {
Victor Stinnerdfe88472019-03-01 12:14:41 +01002151 exit(err.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002152 }
2153 else if (_Py_INIT_IS_ERROR(err)) {
2154 fatal_error(err._func, err.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002155 }
2156 else {
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002157 Py_FatalError("_Py_ExitInitError() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002158 }
Nick Coghland6009512014-11-20 21:39:37 +10002159}
2160
2161/* Clean up and exit */
2162
Victor Stinnerd7292b52016-06-17 12:29:00 +02002163# include "pythread.h"
Nick Coghland6009512014-11-20 21:39:37 +10002164
Nick Coghland6009512014-11-20 21:39:37 +10002165/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002166void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002167{
Victor Stinnercaba55b2018-08-03 15:33:52 +02002168 PyInterpreterState *is = _PyInterpreterState_Get();
Marcel Plch776407f2017-12-20 11:17:58 +01002169
Antoine Pitroufc5db952017-12-13 02:29:07 +01002170 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002171 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2172
2173 is->pyexitfunc = func;
2174 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002175}
2176
2177static void
Marcel Plch776407f2017-12-20 11:17:58 +01002178call_py_exitfuncs(PyInterpreterState *istate)
Nick Coghland6009512014-11-20 21:39:37 +10002179{
Marcel Plch776407f2017-12-20 11:17:58 +01002180 if (istate->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002181 return;
2182
Marcel Plch776407f2017-12-20 11:17:58 +01002183 (*istate->pyexitfunc)(istate->pyexitmodule);
Nick Coghland6009512014-11-20 21:39:37 +10002184 PyErr_Clear();
2185}
2186
2187/* Wait until threading._shutdown completes, provided
2188 the threading module was imported in the first place.
2189 The shutdown routine will wait until all non-daemon
2190 "threading" threads have completed. */
2191static void
2192wait_for_thread_shutdown(void)
2193{
Nick Coghland6009512014-11-20 21:39:37 +10002194 _Py_IDENTIFIER(_shutdown);
2195 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002196 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002197 if (threading == NULL) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002198 if (PyErr_Occurred()) {
2199 PyErr_WriteUnraisable(NULL);
2200 }
2201 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002202 return;
2203 }
Victor Stinner3466bde2016-09-05 18:16:01 -07002204 result = _PyObject_CallMethodId(threading, &PyId__shutdown, NULL);
Nick Coghland6009512014-11-20 21:39:37 +10002205 if (result == NULL) {
2206 PyErr_WriteUnraisable(threading);
2207 }
2208 else {
2209 Py_DECREF(result);
2210 }
2211 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002212}
2213
2214#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002215int Py_AtExit(void (*func)(void))
2216{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002217 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002218 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002219 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002220 return 0;
2221}
2222
2223static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002224call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002225{
Victor Stinner8e91c242019-04-24 17:24:01 +02002226 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002227 /* pop last function from the list */
2228 runtime->nexitfuncs--;
2229 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2230 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2231
2232 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002233 }
Nick Coghland6009512014-11-20 21:39:37 +10002234
2235 fflush(stdout);
2236 fflush(stderr);
2237}
2238
Victor Stinnercfc88312018-08-01 16:41:25 +02002239void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002240Py_Exit(int sts)
2241{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002242 if (Py_FinalizeEx() < 0) {
2243 sts = 120;
2244 }
Nick Coghland6009512014-11-20 21:39:37 +10002245
2246 exit(sts);
2247}
2248
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002249static _PyInitError
Victor Stinner43fc3bb2019-05-02 11:54:20 -04002250init_signals(void)
Nick Coghland6009512014-11-20 21:39:37 +10002251{
2252#ifdef SIGPIPE
2253 PyOS_setsig(SIGPIPE, SIG_IGN);
2254#endif
2255#ifdef SIGXFZ
2256 PyOS_setsig(SIGXFZ, SIG_IGN);
2257#endif
2258#ifdef SIGXFSZ
2259 PyOS_setsig(SIGXFSZ, SIG_IGN);
2260#endif
2261 PyOS_InitInterrupts(); /* May imply initsignal() */
2262 if (PyErr_Occurred()) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002263 return _Py_INIT_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002264 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002265 return _Py_INIT_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002266}
2267
2268
2269/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2270 *
2271 * All of the code in this function must only use async-signal-safe functions,
2272 * listed at `man 7 signal` or
2273 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2274 */
2275void
2276_Py_RestoreSignals(void)
2277{
2278#ifdef SIGPIPE
2279 PyOS_setsig(SIGPIPE, SIG_DFL);
2280#endif
2281#ifdef SIGXFZ
2282 PyOS_setsig(SIGXFZ, SIG_DFL);
2283#endif
2284#ifdef SIGXFSZ
2285 PyOS_setsig(SIGXFSZ, SIG_DFL);
2286#endif
2287}
2288
2289
2290/*
2291 * The file descriptor fd is considered ``interactive'' if either
2292 * a) isatty(fd) is TRUE, or
2293 * b) the -i flag was given, and the filename associated with
2294 * the descriptor is NULL or "<stdin>" or "???".
2295 */
2296int
2297Py_FdIsInteractive(FILE *fp, const char *filename)
2298{
2299 if (isatty((int)fileno(fp)))
2300 return 1;
2301 if (!Py_InteractiveFlag)
2302 return 0;
2303 return (filename == NULL) ||
2304 (strcmp(filename, "<stdin>") == 0) ||
2305 (strcmp(filename, "???") == 0);
2306}
2307
2308
Nick Coghland6009512014-11-20 21:39:37 +10002309/* Wrappers around sigaction() or signal(). */
2310
2311PyOS_sighandler_t
2312PyOS_getsig(int sig)
2313{
2314#ifdef HAVE_SIGACTION
2315 struct sigaction context;
2316 if (sigaction(sig, NULL, &context) == -1)
2317 return SIG_ERR;
2318 return context.sa_handler;
2319#else
2320 PyOS_sighandler_t handler;
2321/* Special signal handling for the secure CRT in Visual Studio 2005 */
2322#if defined(_MSC_VER) && _MSC_VER >= 1400
2323 switch (sig) {
2324 /* Only these signals are valid */
2325 case SIGINT:
2326 case SIGILL:
2327 case SIGFPE:
2328 case SIGSEGV:
2329 case SIGTERM:
2330 case SIGBREAK:
2331 case SIGABRT:
2332 break;
2333 /* Don't call signal() with other values or it will assert */
2334 default:
2335 return SIG_ERR;
2336 }
2337#endif /* _MSC_VER && _MSC_VER >= 1400 */
2338 handler = signal(sig, SIG_IGN);
2339 if (handler != SIG_ERR)
2340 signal(sig, handler);
2341 return handler;
2342#endif
2343}
2344
2345/*
2346 * All of the code in this function must only use async-signal-safe functions,
2347 * listed at `man 7 signal` or
2348 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2349 */
2350PyOS_sighandler_t
2351PyOS_setsig(int sig, PyOS_sighandler_t handler)
2352{
2353#ifdef HAVE_SIGACTION
2354 /* Some code in Modules/signalmodule.c depends on sigaction() being
2355 * used here if HAVE_SIGACTION is defined. Fix that if this code
2356 * changes to invalidate that assumption.
2357 */
2358 struct sigaction context, ocontext;
2359 context.sa_handler = handler;
2360 sigemptyset(&context.sa_mask);
2361 context.sa_flags = 0;
2362 if (sigaction(sig, &context, &ocontext) == -1)
2363 return SIG_ERR;
2364 return ocontext.sa_handler;
2365#else
2366 PyOS_sighandler_t oldhandler;
2367 oldhandler = signal(sig, handler);
2368#ifdef HAVE_SIGINTERRUPT
2369 siginterrupt(sig, 1);
2370#endif
2371 return oldhandler;
2372#endif
2373}
2374
2375#ifdef __cplusplus
2376}
2377#endif