blob: 8bd71a350de86a83379fb1e859ddb65109ba3c09 [file] [log] [blame]
Nick Coghland6009512014-11-20 21:39:37 +10001/* Python interpreter top-level routines, including init/exit */
2
3#include "Python.h"
4
5#include "Python-ast.h"
Victor Stinner3bb183d2018-11-22 18:38:38 +01006#undef Yield /* undefine macro conflicting with <winbase.h> */
Victor Stinner09532fe2019-05-10 23:39:09 +02007#include "pycore_ceval.h"
Victor Stinner99fcc612019-04-29 13:04:07 +02008#include "pycore_context.h"
Victor Stinner0a28f8d2019-06-19 02:54:39 +02009#include "pycore_import.h" /* _PyImport_FindBuiltin */
Victor Stinner331a6a52019-05-27 16:39:22 +020010#include "pycore_initconfig.h"
Victor Stinner353933e2018-11-23 13:08:26 +010011#include "pycore_fileutils.h"
Victor Stinner27e2d1f2018-11-01 00:52:28 +010012#include "pycore_hamt.h"
Victor Stinnera1c249c2018-11-01 03:15:58 +010013#include "pycore_pathconfig.h"
Victor Stinnerb45d2592019-06-20 00:05:23 +020014#include "pycore_pyerrors.h"
Victor Stinner621cebe2018-11-12 16:53:38 +010015#include "pycore_pylifecycle.h"
16#include "pycore_pymem.h"
17#include "pycore_pystate.h"
Victor Stinnered488662019-05-20 00:14:57 +020018#include "pycore_traceback.h"
Nick Coghland6009512014-11-20 21:39:37 +100019#include "grammar.h"
20#include "node.h"
21#include "token.h"
22#include "parsetok.h"
23#include "errcode.h"
24#include "code.h"
25#include "symtable.h"
26#include "ast.h"
27#include "marshal.h"
28#include "osdefs.h"
29#include <locale.h>
30
31#ifdef HAVE_SIGNAL_H
32#include <signal.h>
33#endif
34
35#ifdef MS_WINDOWS
36#include "malloc.h" /* for alloca */
37#endif
38
39#ifdef HAVE_LANGINFO_H
40#include <langinfo.h>
41#endif
42
43#ifdef MS_WINDOWS
44#undef BYTE
45#include "windows.h"
Steve Dower39294992016-08-30 21:22:36 -070046
47extern PyTypeObject PyWindowsConsoleIO_Type;
48#define PyWindowsConsoleIO_Check(op) (PyObject_TypeCheck((op), &PyWindowsConsoleIO_Type))
Nick Coghland6009512014-11-20 21:39:37 +100049#endif
50
51_Py_IDENTIFIER(flush);
52_Py_IDENTIFIER(name);
53_Py_IDENTIFIER(stdin);
54_Py_IDENTIFIER(stdout);
55_Py_IDENTIFIER(stderr);
Eric Snow3f9eee62017-09-15 16:35:20 -060056_Py_IDENTIFIER(threading);
Nick Coghland6009512014-11-20 21:39:37 +100057
58#ifdef __cplusplus
59extern "C" {
60#endif
61
Nick Coghland6009512014-11-20 21:39:37 +100062extern grammar _PyParser_Grammar; /* From graminit.c */
63
Victor Stinnerb45d2592019-06-20 00:05:23 +020064/* Forward declarations */
Victor Stinner331a6a52019-05-27 16:39:22 +020065static PyStatus add_main_module(PyInterpreterState *interp);
Victor Stinnerb45d2592019-06-20 00:05:23 +020066static PyStatus init_import_site(void);
Victor Stinnere0c9ab82019-11-22 16:19:14 +010067static PyStatus init_set_builtins_open(PyThreadState *tstate);
Victor Stinnerb45d2592019-06-20 00:05:23 +020068static PyStatus init_sys_streams(PyThreadState *tstate);
69static PyStatus init_signals(PyThreadState *tstate);
70static void call_py_exitfuncs(PyThreadState *tstate);
71static void wait_for_thread_shutdown(PyThreadState *tstate);
Victor Stinner8e91c242019-04-24 17:24:01 +020072static void call_ll_exitfuncs(_PyRuntimeState *runtime);
Nick Coghland6009512014-11-20 21:39:37 +100073
Gregory P. Smith38f11cc2019-02-16 12:57:40 -080074int _Py_UnhandledKeyboardInterrupt = 0;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080075_PyRuntimeState _PyRuntime = _PyRuntimeState_INIT;
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010076static int runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -060077
Victor Stinner331a6a52019-05-27 16:39:22 +020078PyStatus
Eric Snow2ebc5ce2017-09-07 23:51:28 -060079_PyRuntime_Initialize(void)
80{
81 /* XXX We only initialize once in the process, which aligns with
82 the static initialization of the former globals now found in
83 _PyRuntime. However, _PyRuntime *should* be initialized with
84 every Py_Initialize() call, but doing so breaks the runtime.
85 This is because the runtime state is not properly finalized
86 currently. */
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010087 if (runtime_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +020088 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -080089 }
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010090 runtime_initialized = 1;
Victor Stinnerf7e5b562017-11-15 15:48:08 -080091
92 return _PyRuntimeState_Init(&_PyRuntime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -060093}
94
95void
96_PyRuntime_Finalize(void)
97{
98 _PyRuntimeState_Fini(&_PyRuntime);
Victor Stinnerfd23cfa2019-03-20 00:03:01 +010099 runtime_initialized = 0;
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600100}
101
102int
103_Py_IsFinalizing(void)
104{
105 return _PyRuntime.finalizing != NULL;
106}
107
Nick Coghland6009512014-11-20 21:39:37 +1000108/* Hack to force loading of object files */
109int (*_PyOS_mystrnicmp_hack)(const char *, const char *, Py_ssize_t) = \
110 PyOS_mystrnicmp; /* Python/pystrcmp.o */
111
112/* PyModule_GetWarningsModule is no longer necessary as of 2.6
113since _warnings is builtin. This API should not be used. */
114PyObject *
115PyModule_GetWarningsModule(void)
116{
117 return PyImport_ImportModule("warnings");
118}
119
Eric Snowc7ec9982017-05-23 23:00:52 -0700120
Eric Snow1abcf672017-05-23 21:46:51 -0700121/* APIs to access the initialization flags
122 *
123 * Can be called prior to Py_Initialize.
124 */
Nick Coghland6009512014-11-20 21:39:37 +1000125
Eric Snow1abcf672017-05-23 21:46:51 -0700126int
127_Py_IsCoreInitialized(void)
128{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600129 return _PyRuntime.core_initialized;
Eric Snow1abcf672017-05-23 21:46:51 -0700130}
Nick Coghland6009512014-11-20 21:39:37 +1000131
132int
133Py_IsInitialized(void)
134{
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600135 return _PyRuntime.initialized;
Nick Coghland6009512014-11-20 21:39:37 +1000136}
137
Nick Coghlan6ea41862017-06-11 13:16:15 +1000138
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000139/* Global initializations. Can be undone by Py_FinalizeEx(). Don't
140 call this twice without an intervening Py_FinalizeEx() call. When
Nick Coghland6009512014-11-20 21:39:37 +1000141 initializations fail, a fatal error is issued and the function does
142 not return. On return, the first thread and interpreter state have
143 been created.
144
145 Locking: you must hold the interpreter lock while calling this.
146 (If the lock has not yet been initialized, that's equivalent to
147 having the lock, but you cannot use multiple threads.)
148
149*/
150
Victor Stinner331a6a52019-05-27 16:39:22 +0200151static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200152init_importlib(PyThreadState *tstate, PyObject *sysmod)
Nick Coghland6009512014-11-20 21:39:37 +1000153{
154 PyObject *importlib;
155 PyObject *impmod;
Nick Coghland6009512014-11-20 21:39:37 +1000156 PyObject *value;
Victor Stinnerb45d2592019-06-20 00:05:23 +0200157 PyInterpreterState *interp = tstate->interp;
Victor Stinner331a6a52019-05-27 16:39:22 +0200158 int verbose = interp->config.verbose;
Nick Coghland6009512014-11-20 21:39:37 +1000159
160 /* Import _importlib through its frozen version, _frozen_importlib. */
161 if (PyImport_ImportFrozenModule("_frozen_importlib") <= 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200162 return _PyStatus_ERR("can't import _frozen_importlib");
Nick Coghland6009512014-11-20 21:39:37 +1000163 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200164 else if (verbose) {
Nick Coghland6009512014-11-20 21:39:37 +1000165 PySys_FormatStderr("import _frozen_importlib # frozen\n");
166 }
167 importlib = PyImport_AddModule("_frozen_importlib");
168 if (importlib == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200169 return _PyStatus_ERR("couldn't get _frozen_importlib from sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000170 }
171 interp->importlib = importlib;
172 Py_INCREF(interp->importlib);
173
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300174 interp->import_func = PyDict_GetItemString(interp->builtins, "__import__");
175 if (interp->import_func == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +0200176 return _PyStatus_ERR("__import__ not found");
Serhiy Storchaka133138a2016-08-02 22:51:21 +0300177 Py_INCREF(interp->import_func);
178
Victor Stinnercd6e6942015-09-18 09:11:57 +0200179 /* Import the _imp module */
Benjamin Petersonc65ef772018-01-29 11:33:57 -0800180 impmod = PyInit__imp();
Nick Coghland6009512014-11-20 21:39:37 +1000181 if (impmod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200182 return _PyStatus_ERR("can't import _imp");
Nick Coghland6009512014-11-20 21:39:37 +1000183 }
Victor Stinnerc96be812019-05-14 17:34:56 +0200184 else if (verbose) {
Victor Stinnercd6e6942015-09-18 09:11:57 +0200185 PySys_FormatStderr("import _imp # builtin\n");
Nick Coghland6009512014-11-20 21:39:37 +1000186 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600187 if (_PyImport_SetModuleString("_imp", impmod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200188 return _PyStatus_ERR("can't save _imp to sys.modules");
Nick Coghland6009512014-11-20 21:39:37 +1000189 }
190
Victor Stinnercd6e6942015-09-18 09:11:57 +0200191 /* Install importlib as the implementation of import */
Nick Coghland6009512014-11-20 21:39:37 +1000192 value = PyObject_CallMethod(importlib, "_install", "OO", sysmod, impmod);
193 if (value == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200194 _PyErr_Print(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200195 return _PyStatus_ERR("importlib install failed");
Nick Coghland6009512014-11-20 21:39:37 +1000196 }
197 Py_DECREF(value);
198 Py_DECREF(impmod);
199
Victor Stinner331a6a52019-05-27 16:39:22 +0200200 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +1000201}
202
Victor Stinner331a6a52019-05-27 16:39:22 +0200203static PyStatus
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200204init_importlib_external(PyThreadState *tstate)
Eric Snow1abcf672017-05-23 21:46:51 -0700205{
206 PyObject *value;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200207 value = PyObject_CallMethod(tstate->interp->importlib,
Eric Snow1abcf672017-05-23 21:46:51 -0700208 "_install_external_importers", "");
209 if (value == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200210 _PyErr_Print(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200211 return _PyStatus_ERR("external importer setup failed");
Eric Snow1abcf672017-05-23 21:46:51 -0700212 }
Stéphane Wirtelab1cb802017-06-08 13:13:20 +0200213 Py_DECREF(value);
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200214 return _PyImportZip_Init(tstate);
Eric Snow1abcf672017-05-23 21:46:51 -0700215}
Nick Coghland6009512014-11-20 21:39:37 +1000216
Nick Coghlan6ea41862017-06-11 13:16:15 +1000217/* Helper functions to better handle the legacy C locale
218 *
219 * The legacy C locale assumes ASCII as the default text encoding, which
220 * causes problems not only for the CPython runtime, but also other
221 * components like GNU readline.
222 *
223 * Accordingly, when the CLI detects it, it attempts to coerce it to a
224 * more capable UTF-8 based alternative as follows:
225 *
226 * if (_Py_LegacyLocaleDetected()) {
227 * _Py_CoerceLegacyLocale();
228 * }
229 *
230 * See the documentation of the PYTHONCOERCECLOCALE setting for more details.
231 *
232 * Locale coercion also impacts the default error handler for the standard
233 * streams: while the usual default is "strict", the default for the legacy
234 * C locale and for any of the coercion target locales is "surrogateescape".
235 */
236
237int
Victor Stinner0f721472019-05-20 17:16:38 +0200238_Py_LegacyLocaleDetected(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000239{
240#ifndef MS_WINDOWS
Victor Stinner0f721472019-05-20 17:16:38 +0200241 if (!warn) {
242 const char *locale_override = getenv("LC_ALL");
243 if (locale_override != NULL && *locale_override != '\0') {
244 /* Don't coerce C locale if the LC_ALL environment variable
245 is set */
246 return 0;
247 }
248 }
249
Nick Coghlan6ea41862017-06-11 13:16:15 +1000250 /* On non-Windows systems, the C locale is considered a legacy locale */
Nick Coghlaneb817952017-06-18 12:29:42 +1000251 /* XXX (ncoghlan): some platforms (notably Mac OS X) don't appear to treat
252 * the POSIX locale as a simple alias for the C locale, so
253 * we may also want to check for that explicitly.
254 */
Nick Coghlan6ea41862017-06-11 13:16:15 +1000255 const char *ctype_loc = setlocale(LC_CTYPE, NULL);
256 return ctype_loc != NULL && strcmp(ctype_loc, "C") == 0;
257#else
258 /* Windows uses code pages instead of locales, so no locale is legacy */
259 return 0;
260#endif
261}
262
Victor Stinnerb0051362019-11-22 17:52:42 +0100263#ifndef MS_WINDOWS
Nick Coghlaneb817952017-06-18 12:29:42 +1000264static const char *_C_LOCALE_WARNING =
265 "Python runtime initialized with LC_CTYPE=C (a locale with default ASCII "
266 "encoding), which may cause Unicode compatibility problems. Using C.UTF-8, "
267 "C.utf8, or UTF-8 (if available) as alternative Unicode-compatible "
268 "locales is recommended.\n";
269
Nick Coghlaneb817952017-06-18 12:29:42 +1000270static void
Victor Stinner43125222019-04-24 18:23:53 +0200271emit_stderr_warning_for_legacy_locale(_PyRuntimeState *runtime)
Nick Coghlaneb817952017-06-18 12:29:42 +1000272{
Victor Stinner331a6a52019-05-27 16:39:22 +0200273 const PyPreConfig *preconfig = &runtime->preconfig;
Victor Stinner0f721472019-05-20 17:16:38 +0200274 if (preconfig->coerce_c_locale_warn && _Py_LegacyLocaleDetected(1)) {
Victor Stinnercf215042018-08-29 22:56:06 +0200275 PySys_FormatStderr("%s", _C_LOCALE_WARNING);
Nick Coghlaneb817952017-06-18 12:29:42 +1000276 }
277}
Victor Stinnerb0051362019-11-22 17:52:42 +0100278#endif /* !defined(MS_WINDOWS) */
Nick Coghlaneb817952017-06-18 12:29:42 +1000279
Nick Coghlan6ea41862017-06-11 13:16:15 +1000280typedef struct _CandidateLocale {
281 const char *locale_name; /* The locale to try as a coercion target */
282} _LocaleCoercionTarget;
283
284static _LocaleCoercionTarget _TARGET_LOCALES[] = {
285 {"C.UTF-8"},
286 {"C.utf8"},
Nick Coghlan18974c32017-06-30 00:48:14 +1000287 {"UTF-8"},
Nick Coghlan6ea41862017-06-11 13:16:15 +1000288 {NULL}
289};
290
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200291
292int
293_Py_IsLocaleCoercionTarget(const char *ctype_loc)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000294{
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200295 const _LocaleCoercionTarget *target = NULL;
296 for (target = _TARGET_LOCALES; target->locale_name; target++) {
297 if (strcmp(ctype_loc, target->locale_name) == 0) {
298 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000299 }
Victor Stinner124b9eb2018-08-29 01:29:06 +0200300 }
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200301 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000302}
303
Victor Stinnerdfe0dc72018-08-29 11:47:29 +0200304
Nick Coghlan6ea41862017-06-11 13:16:15 +1000305#ifdef PY_COERCE_C_LOCALE
Victor Stinner94540602017-12-16 04:54:22 +0100306static const char C_LOCALE_COERCION_WARNING[] =
Nick Coghlan6ea41862017-06-11 13:16:15 +1000307 "Python detected LC_CTYPE=C: LC_CTYPE coerced to %.20s (set another locale "
308 "or PYTHONCOERCECLOCALE=0 to disable this locale coercion behavior).\n";
309
Victor Stinner0f721472019-05-20 17:16:38 +0200310static int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200311_coerce_default_locale_settings(int warn, const _LocaleCoercionTarget *target)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000312{
313 const char *newloc = target->locale_name;
314
315 /* Reset locale back to currently configured defaults */
xdegaye1588be62017-11-12 12:45:59 +0100316 _Py_SetLocaleFromEnv(LC_ALL);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000317
318 /* Set the relevant locale environment variable */
319 if (setenv("LC_CTYPE", newloc, 1)) {
320 fprintf(stderr,
321 "Error setting LC_CTYPE, skipping C locale coercion\n");
Victor Stinner0f721472019-05-20 17:16:38 +0200322 return 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000323 }
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200324 if (warn) {
Victor Stinner94540602017-12-16 04:54:22 +0100325 fprintf(stderr, C_LOCALE_COERCION_WARNING, newloc);
Nick Coghlaneb817952017-06-18 12:29:42 +1000326 }
Nick Coghlan6ea41862017-06-11 13:16:15 +1000327
328 /* Reconfigure with the overridden environment variables */
xdegaye1588be62017-11-12 12:45:59 +0100329 _Py_SetLocaleFromEnv(LC_ALL);
Victor Stinner0f721472019-05-20 17:16:38 +0200330 return 1;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000331}
332#endif
333
Victor Stinner0f721472019-05-20 17:16:38 +0200334int
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200335_Py_CoerceLegacyLocale(int warn)
Nick Coghlan6ea41862017-06-11 13:16:15 +1000336{
Victor Stinner0f721472019-05-20 17:16:38 +0200337 int coerced = 0;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000338#ifdef PY_COERCE_C_LOCALE
Victor Stinner8ea09112018-09-03 17:05:18 +0200339 char *oldloc = NULL;
340
341 oldloc = _PyMem_RawStrdup(setlocale(LC_CTYPE, NULL));
342 if (oldloc == NULL) {
Victor Stinner0f721472019-05-20 17:16:38 +0200343 return coerced;
Victor Stinner8ea09112018-09-03 17:05:18 +0200344 }
345
Victor Stinner94540602017-12-16 04:54:22 +0100346 const char *locale_override = getenv("LC_ALL");
347 if (locale_override == NULL || *locale_override == '\0') {
348 /* LC_ALL is also not set (or is set to an empty string) */
349 const _LocaleCoercionTarget *target = NULL;
350 for (target = _TARGET_LOCALES; target->locale_name; target++) {
351 const char *new_locale = setlocale(LC_CTYPE,
352 target->locale_name);
353 if (new_locale != NULL) {
Victor Stinnere2510952019-05-02 11:28:57 -0400354#if !defined(_Py_FORCE_UTF8_LOCALE) && defined(HAVE_LANGINFO_H) && defined(CODESET)
Victor Stinner94540602017-12-16 04:54:22 +0100355 /* Also ensure that nl_langinfo works in this locale */
356 char *codeset = nl_langinfo(CODESET);
357 if (!codeset || *codeset == '\0') {
358 /* CODESET is not set or empty, so skip coercion */
359 new_locale = NULL;
360 _Py_SetLocaleFromEnv(LC_CTYPE);
361 continue;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000362 }
Victor Stinner94540602017-12-16 04:54:22 +0100363#endif
364 /* Successfully configured locale, so make it the default */
Victor Stinner0f721472019-05-20 17:16:38 +0200365 coerced = _coerce_default_locale_settings(warn, target);
Victor Stinner8ea09112018-09-03 17:05:18 +0200366 goto done;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000367 }
368 }
369 }
370 /* No C locale warning here, as Py_Initialize will emit one later */
Victor Stinner8ea09112018-09-03 17:05:18 +0200371
372 setlocale(LC_CTYPE, oldloc);
373
374done:
375 PyMem_RawFree(oldloc);
Nick Coghlan6ea41862017-06-11 13:16:15 +1000376#endif
Victor Stinner0f721472019-05-20 17:16:38 +0200377 return coerced;
Nick Coghlan6ea41862017-06-11 13:16:15 +1000378}
379
xdegaye1588be62017-11-12 12:45:59 +0100380/* _Py_SetLocaleFromEnv() is a wrapper around setlocale(category, "") to
381 * isolate the idiosyncrasies of different libc implementations. It reads the
382 * appropriate environment variable and uses its value to select the locale for
383 * 'category'. */
384char *
385_Py_SetLocaleFromEnv(int category)
386{
Victor Stinner353933e2018-11-23 13:08:26 +0100387 char *res;
xdegaye1588be62017-11-12 12:45:59 +0100388#ifdef __ANDROID__
389 const char *locale;
390 const char **pvar;
391#ifdef PY_COERCE_C_LOCALE
392 const char *coerce_c_locale;
393#endif
394 const char *utf8_locale = "C.UTF-8";
395 const char *env_var_set[] = {
396 "LC_ALL",
397 "LC_CTYPE",
398 "LANG",
399 NULL,
400 };
401
402 /* Android setlocale(category, "") doesn't check the environment variables
403 * and incorrectly sets the "C" locale at API 24 and older APIs. We only
404 * check the environment variables listed in env_var_set. */
405 for (pvar=env_var_set; *pvar; pvar++) {
406 locale = getenv(*pvar);
407 if (locale != NULL && *locale != '\0') {
408 if (strcmp(locale, utf8_locale) == 0 ||
409 strcmp(locale, "en_US.UTF-8") == 0) {
410 return setlocale(category, utf8_locale);
411 }
412 return setlocale(category, "C");
413 }
414 }
415
416 /* Android uses UTF-8, so explicitly set the locale to C.UTF-8 if none of
417 * LC_ALL, LC_CTYPE, or LANG is set to a non-empty string.
418 * Quote from POSIX section "8.2 Internationalization Variables":
419 * "4. If the LANG environment variable is not set or is set to the empty
420 * string, the implementation-defined default locale shall be used." */
421
422#ifdef PY_COERCE_C_LOCALE
423 coerce_c_locale = getenv("PYTHONCOERCECLOCALE");
424 if (coerce_c_locale == NULL || strcmp(coerce_c_locale, "0") != 0) {
425 /* Some other ported code may check the environment variables (e.g. in
426 * extension modules), so we make sure that they match the locale
427 * configuration */
428 if (setenv("LC_CTYPE", utf8_locale, 1)) {
429 fprintf(stderr, "Warning: failed setting the LC_CTYPE "
430 "environment variable to %s\n", utf8_locale);
431 }
432 }
433#endif
Victor Stinner353933e2018-11-23 13:08:26 +0100434 res = setlocale(category, utf8_locale);
435#else /* !defined(__ANDROID__) */
436 res = setlocale(category, "");
437#endif
438 _Py_ResetForceASCII();
439 return res;
xdegaye1588be62017-11-12 12:45:59 +0100440}
441
Nick Coghlan6ea41862017-06-11 13:16:15 +1000442
Eric Snow1abcf672017-05-23 21:46:51 -0700443/* Global initializations. Can be undone by Py_Finalize(). Don't
444 call this twice without an intervening Py_Finalize() call.
445
Victor Stinner331a6a52019-05-27 16:39:22 +0200446 Every call to Py_InitializeFromConfig, Py_Initialize or Py_InitializeEx
Eric Snow1abcf672017-05-23 21:46:51 -0700447 must have a corresponding call to Py_Finalize.
448
449 Locking: you must hold the interpreter lock while calling these APIs.
450 (If the lock has not yet been initialized, that's equivalent to
451 having the lock, but you cannot use multiple threads.)
452
453*/
454
Victor Stinner331a6a52019-05-27 16:39:22 +0200455static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200456pyinit_core_reconfigure(_PyRuntimeState *runtime,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200457 PyThreadState **tstate_p,
Victor Stinner331a6a52019-05-27 16:39:22 +0200458 const PyConfig *config)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200459{
Victor Stinner331a6a52019-05-27 16:39:22 +0200460 PyStatus status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100461 PyThreadState *tstate = _PyThreadState_GET();
462 if (!tstate) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200463 return _PyStatus_ERR("failed to read thread state");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100464 }
Victor Stinnerb45d2592019-06-20 00:05:23 +0200465 *tstate_p = tstate;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100466
467 PyInterpreterState *interp = tstate->interp;
468 if (interp == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200469 return _PyStatus_ERR("can't make main interpreter");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100470 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100471
Victor Stinner331a6a52019-05-27 16:39:22 +0200472 _PyConfig_Write(config, runtime);
Victor Stinner1dc6e392018-07-25 02:49:17 +0200473
Victor Stinner331a6a52019-05-27 16:39:22 +0200474 status = _PyConfig_Copy(&interp->config, config);
475 if (_PyStatus_EXCEPTION(status)) {
476 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200477 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200478 config = &interp->config;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200479
Victor Stinner331a6a52019-05-27 16:39:22 +0200480 if (config->_install_importlib) {
Victor Stinner12f2f172019-09-26 15:51:50 +0200481 status = _PyConfig_WritePathConfig(config);
Victor Stinner331a6a52019-05-27 16:39:22 +0200482 if (_PyStatus_EXCEPTION(status)) {
483 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200484 }
485 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200486 return _PyStatus_OK();
Victor Stinner1dc6e392018-07-25 02:49:17 +0200487}
488
489
Victor Stinner331a6a52019-05-27 16:39:22 +0200490static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200491pycore_init_runtime(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200492 const PyConfig *config)
Nick Coghland6009512014-11-20 21:39:37 +1000493{
Victor Stinner43125222019-04-24 18:23:53 +0200494 if (runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200495 return _PyStatus_ERR("main interpreter already initialized");
Victor Stinner1dc6e392018-07-25 02:49:17 +0200496 }
Victor Stinnerda273412017-12-15 01:46:02 +0100497
Victor Stinner331a6a52019-05-27 16:39:22 +0200498 _PyConfig_Write(config, runtime);
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600499
Eric Snow1abcf672017-05-23 21:46:51 -0700500 /* Py_Finalize leaves _Py_Finalizing set in order to help daemon
501 * threads behave a little more gracefully at interpreter shutdown.
502 * We clobber it here so the new interpreter can start with a clean
503 * slate.
504 *
505 * However, this may still lead to misbehaviour if there are daemon
506 * threads still hanging around from a previous Py_Initialize/Finalize
507 * pair :(
508 */
Victor Stinner43125222019-04-24 18:23:53 +0200509 runtime->finalizing = NULL;
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600510
Victor Stinner331a6a52019-05-27 16:39:22 +0200511 PyStatus status = _Py_HashRandomization_Init(config);
512 if (_PyStatus_EXCEPTION(status)) {
513 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800514 }
515
Victor Stinner331a6a52019-05-27 16:39:22 +0200516 status = _PyInterpreterState_Enable(runtime);
517 if (_PyStatus_EXCEPTION(status)) {
518 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -0800519 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200520 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100521}
Victor Stinnera7368ac2017-11-15 18:11:45 -0800522
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100523
Victor Stinner331a6a52019-05-27 16:39:22 +0200524static PyStatus
Victor Stinner43125222019-04-24 18:23:53 +0200525pycore_create_interpreter(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200526 const PyConfig *config,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200527 PyThreadState **tstate_p)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100528{
529 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnerda273412017-12-15 01:46:02 +0100530 if (interp == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200531 return _PyStatus_ERR("can't make main interpreter");
Victor Stinnerda273412017-12-15 01:46:02 +0100532 }
533
Victor Stinner331a6a52019-05-27 16:39:22 +0200534 PyStatus status = _PyConfig_Copy(&interp->config, config);
535 if (_PyStatus_EXCEPTION(status)) {
536 return status;
Victor Stinnerda273412017-12-15 01:46:02 +0100537 }
Nick Coghland6009512014-11-20 21:39:37 +1000538
Victor Stinnerd19d8d52018-07-24 13:55:48 +0200539 PyThreadState *tstate = PyThreadState_New(interp);
Victor Stinnerb45d2592019-06-20 00:05:23 +0200540 if (tstate == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200541 return _PyStatus_ERR("can't make first thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +0200542 }
Nick Coghland6009512014-11-20 21:39:37 +1000543 (void) PyThreadState_Swap(tstate);
544
Victor Stinner99fcc612019-04-29 13:04:07 +0200545 /* We can't call _PyEval_FiniThreads() in Py_FinalizeEx because
546 destroying the GIL might fail when it is being referenced from
547 another running thread (see issue #9901).
Nick Coghland6009512014-11-20 21:39:37 +1000548 Instead we destroy the previously created GIL here, which ensures
Martin Panterb4ce1fc2015-11-30 03:18:29 +0000549 that we can call Py_Initialize / Py_FinalizeEx multiple times. */
Victor Stinner09532fe2019-05-10 23:39:09 +0200550 _PyEval_FiniThreads(&runtime->ceval);
Victor Stinner2914bb32018-01-29 11:57:45 +0100551
Nick Coghland6009512014-11-20 21:39:37 +1000552 /* Auto-thread-state API */
Victor Stinner01b1cc12019-11-20 02:27:56 +0100553 _PyGILState_Init(tstate);
Nick Coghland6009512014-11-20 21:39:37 +1000554
Victor Stinner2914bb32018-01-29 11:57:45 +0100555 /* Create the GIL */
556 PyEval_InitThreads();
557
Victor Stinnerb45d2592019-06-20 00:05:23 +0200558 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +0200559 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100560}
Nick Coghland6009512014-11-20 21:39:37 +1000561
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100562
Victor Stinner331a6a52019-05-27 16:39:22 +0200563static PyStatus
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100564pycore_init_types(PyThreadState *tstate)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100565{
Victor Stinner444b39b2019-11-20 01:18:11 +0100566 PyStatus status;
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100567 int is_main_interp = _Py_IsMainInterpreter(tstate);
Victor Stinner444b39b2019-11-20 01:18:11 +0100568
Victor Stinner01b1cc12019-11-20 02:27:56 +0100569 status = _PyGC_Init(tstate);
Victor Stinner444b39b2019-11-20 01:18:11 +0100570 if (_PyStatus_EXCEPTION(status)) {
571 return status;
572 }
573
Victor Stinnere7e699e2019-11-20 12:08:13 +0100574 if (is_main_interp) {
575 status = _PyTypes_Init();
576 if (_PyStatus_EXCEPTION(status)) {
577 return status;
578 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100579
Victor Stinnere7e699e2019-11-20 12:08:13 +0100580 if (!_PyLong_Init()) {
581 return _PyStatus_ERR("can't init longs");
582 }
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100583 }
Victor Stinneref5aa9a2019-11-20 00:38:03 +0100584
Victor Stinnerb93f31f2019-11-20 18:39:12 +0100585 if (is_main_interp) {
Victor Stinnere7e699e2019-11-20 12:08:13 +0100586 status = _PyUnicode_Init();
587 if (_PyStatus_EXCEPTION(status)) {
588 return status;
589 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100590 }
591
Victor Stinner331a6a52019-05-27 16:39:22 +0200592 status = _PyExc_Init();
593 if (_PyStatus_EXCEPTION(status)) {
594 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100595 }
596
Victor Stinnere7e699e2019-11-20 12:08:13 +0100597 if (is_main_interp) {
598 if (!_PyFloat_Init()) {
599 return _PyStatus_ERR("can't init float");
600 }
Nick Coghland6009512014-11-20 21:39:37 +1000601
Victor Stinnere7e699e2019-11-20 12:08:13 +0100602 if (_PyStructSequence_Init() < 0) {
603 return _PyStatus_ERR("can't initialize structseq");
604 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100605 }
Victor Stinneref9d9b62019-05-22 11:28:22 +0200606
Victor Stinner331a6a52019-05-27 16:39:22 +0200607 status = _PyErr_Init();
608 if (_PyStatus_EXCEPTION(status)) {
609 return status;
Victor Stinneref9d9b62019-05-22 11:28:22 +0200610 }
611
Victor Stinnere7e699e2019-11-20 12:08:13 +0100612 if (is_main_interp) {
613 if (!_PyContext_Init()) {
614 return _PyStatus_ERR("can't init context");
615 }
Victor Stinneref5aa9a2019-11-20 00:38:03 +0100616 }
617
Victor Stinner331a6a52019-05-27 16:39:22 +0200618 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100619}
620
621
Victor Stinner331a6a52019-05-27 16:39:22 +0200622static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200623pycore_init_builtins(PyThreadState *tstate)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100624{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100625 assert(!_PyErr_Occurred(tstate));
626
Victor Stinnerb45d2592019-06-20 00:05:23 +0200627 PyObject *bimod = _PyBuiltin_Init(tstate);
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100628 if (bimod == NULL) {
Victor Stinner2582d462019-11-22 19:24:49 +0100629 goto error;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100630 }
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100631
Victor Stinner2582d462019-11-22 19:24:49 +0100632 PyInterpreterState *interp = tstate->interp;
633 if (_PyImport_FixupBuiltin(bimod, "builtins", interp->modules) < 0) {
634 goto error;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100635 }
Victor Stinner2582d462019-11-22 19:24:49 +0100636
637 PyObject *builtins_dict = PyModule_GetDict(bimod);
638 if (builtins_dict == NULL) {
639 goto error;
640 }
641 Py_INCREF(builtins_dict);
642 interp->builtins = builtins_dict;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100643
Victor Stinner331a6a52019-05-27 16:39:22 +0200644 PyStatus status = _PyBuiltins_AddExceptions(bimod);
645 if (_PyStatus_EXCEPTION(status)) {
646 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100647 }
Victor Stinner2582d462019-11-22 19:24:49 +0100648
649 interp->builtins_copy = PyDict_Copy(interp->builtins);
650 if (interp->builtins_copy == NULL) {
651 goto error;
652 }
Pablo Galindob96c6b02019-12-04 11:19:59 +0000653 Py_DECREF(bimod);
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100654
655 assert(!_PyErr_Occurred(tstate));
656
Victor Stinner331a6a52019-05-27 16:39:22 +0200657 return _PyStatus_OK();
Victor Stinner2582d462019-11-22 19:24:49 +0100658
659error:
Pablo Galindob96c6b02019-12-04 11:19:59 +0000660 Py_XDECREF(bimod);
Victor Stinner2582d462019-11-22 19:24:49 +0100661 return _PyStatus_ERR("can't initialize builtins module");
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100662}
663
664
Victor Stinner331a6a52019-05-27 16:39:22 +0200665static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +0200666pycore_init_import_warnings(PyThreadState *tstate, PyObject *sysmod)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100667{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100668 assert(!_PyErr_Occurred(tstate));
Victor Stinnerb45d2592019-06-20 00:05:23 +0200669
Victor Stinner2582d462019-11-22 19:24:49 +0100670 PyStatus status = _PyImportHooks_Init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200671 if (_PyStatus_EXCEPTION(status)) {
672 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800673 }
Nick Coghland6009512014-11-20 21:39:37 +1000674
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100675 const PyConfig *config = &tstate->interp->config;
Victor Stinner2ec1a1b2019-11-22 21:54:33 +0100676 if (_Py_IsMainInterpreter(tstate)) {
677 /* Initialize _warnings. */
678 if (_PyWarnings_Init() == NULL) {
679 return _PyStatus_ERR("can't initialize warnings");
680 }
Nick Coghland6009512014-11-20 21:39:37 +1000681
Victor Stinner2ec1a1b2019-11-22 21:54:33 +0100682 if (config->_install_importlib) {
683 status = _PyConfig_WritePathConfig(config);
684 if (_PyStatus_EXCEPTION(status)) {
685 return status;
686 }
Victor Stinnerb1147e42018-07-21 02:06:16 +0200687 }
688 }
689
Eric Snow1abcf672017-05-23 21:46:51 -0700690 /* This call sets up builtin and frozen import support */
Victor Stinnerb45d2592019-06-20 00:05:23 +0200691 if (config->_install_importlib) {
692 status = init_importlib(tstate, sysmod);
Victor Stinner331a6a52019-05-27 16:39:22 +0200693 if (_PyStatus_EXCEPTION(status)) {
694 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800695 }
Eric Snow1abcf672017-05-23 21:46:51 -0700696 }
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100697
698 assert(!_PyErr_Occurred(tstate));
699
Victor Stinner331a6a52019-05-27 16:39:22 +0200700 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100701}
702
703
Victor Stinner331a6a52019-05-27 16:39:22 +0200704static PyStatus
Victor Stinnerd863ade2019-12-06 03:37:07 +0100705pycore_interp_init(PyThreadState *tstate)
706{
707 PyStatus status;
708
709 status = pycore_init_types(tstate);
710 if (_PyStatus_EXCEPTION(status)) {
711 return status;
712 }
713
714 PyObject *sysmod;
715 status = _PySys_Create(tstate, &sysmod);
716 if (_PyStatus_EXCEPTION(status)) {
717 return status;
718 }
719
720 status = pycore_init_builtins(tstate);
721 if (_PyStatus_EXCEPTION(status)) {
722 return status;
723 }
724
725 return pycore_init_import_warnings(tstate, sysmod);
726}
727
728
729static PyStatus
Victor Stinner331a6a52019-05-27 16:39:22 +0200730pyinit_config(_PyRuntimeState *runtime,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200731 PyThreadState **tstate_p,
Victor Stinner331a6a52019-05-27 16:39:22 +0200732 const PyConfig *config)
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100733{
Victor Stinner331a6a52019-05-27 16:39:22 +0200734 _PyConfig_Write(config, runtime);
Victor Stinner20004952019-03-26 02:31:11 +0100735
Victor Stinner331a6a52019-05-27 16:39:22 +0200736 PyStatus status = pycore_init_runtime(runtime, config);
737 if (_PyStatus_EXCEPTION(status)) {
738 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100739 }
740
Victor Stinnerb45d2592019-06-20 00:05:23 +0200741 PyThreadState *tstate;
742 status = pycore_create_interpreter(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200743 if (_PyStatus_EXCEPTION(status)) {
744 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100745 }
Victor Stinnerb45d2592019-06-20 00:05:23 +0200746 config = &tstate->interp->config;
747 *tstate_p = tstate;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100748
Victor Stinnerd863ade2019-12-06 03:37:07 +0100749 status = pycore_interp_init(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +0200750 if (_PyStatus_EXCEPTION(status)) {
751 return status;
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100752 }
Eric Snow1abcf672017-05-23 21:46:51 -0700753
754 /* Only when we get here is the runtime core fully initialized */
Victor Stinner43125222019-04-24 18:23:53 +0200755 runtime->core_initialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200756 return _PyStatus_OK();
Eric Snow1abcf672017-05-23 21:46:51 -0700757}
758
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100759
Victor Stinner331a6a52019-05-27 16:39:22 +0200760PyStatus
761_Py_PreInitializeFromPyArgv(const PyPreConfig *src_config, const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100762{
Victor Stinner331a6a52019-05-27 16:39:22 +0200763 PyStatus status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100764
Victor Stinner6d1c4672019-05-20 11:02:00 +0200765 if (src_config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200766 return _PyStatus_ERR("preinitialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +0200767 }
768
Victor Stinner331a6a52019-05-27 16:39:22 +0200769 status = _PyRuntime_Initialize();
770 if (_PyStatus_EXCEPTION(status)) {
771 return status;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100772 }
Victor Stinner43125222019-04-24 18:23:53 +0200773 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100774
Victor Stinnerd3b90412019-09-17 23:59:51 +0200775 if (runtime->preinitialized) {
Victor Stinnerf72346c2019-03-25 17:54:58 +0100776 /* If it's already configured: ignored the new configuration */
Victor Stinner331a6a52019-05-27 16:39:22 +0200777 return _PyStatus_OK();
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100778 }
779
Victor Stinnerd3b90412019-09-17 23:59:51 +0200780 /* Note: preinitialized remains 1 on error, it is only set to 0
781 at exit on success. */
782 runtime->preinitializing = 1;
783
Victor Stinner331a6a52019-05-27 16:39:22 +0200784 PyPreConfig config;
Victor Stinner441b10c2019-09-28 04:28:35 +0200785
786 status = _PyPreConfig_InitFromPreConfig(&config, src_config);
787 if (_PyStatus_EXCEPTION(status)) {
788 return status;
789 }
Victor Stinnerf72346c2019-03-25 17:54:58 +0100790
Victor Stinner331a6a52019-05-27 16:39:22 +0200791 status = _PyPreConfig_Read(&config, args);
792 if (_PyStatus_EXCEPTION(status)) {
793 return status;
Victor Stinnerf29084d2019-03-20 02:20:13 +0100794 }
795
Victor Stinner331a6a52019-05-27 16:39:22 +0200796 status = _PyPreConfig_Write(&config);
797 if (_PyStatus_EXCEPTION(status)) {
798 return status;
Victor Stinnerf72346c2019-03-25 17:54:58 +0100799 }
800
Victor Stinnerd3b90412019-09-17 23:59:51 +0200801 runtime->preinitializing = 0;
802 runtime->preinitialized = 1;
Victor Stinner331a6a52019-05-27 16:39:22 +0200803 return _PyStatus_OK();
Victor Stinnerf72346c2019-03-25 17:54:58 +0100804}
805
Victor Stinner70005ac2019-05-02 15:25:34 -0400806
Victor Stinner331a6a52019-05-27 16:39:22 +0200807PyStatus
808Py_PreInitializeFromBytesArgs(const PyPreConfig *src_config, Py_ssize_t argc, char **argv)
Victor Stinnerf72346c2019-03-25 17:54:58 +0100809{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100810 _PyArgv args = {.use_bytes_argv = 1, .argc = argc, .bytes_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400811 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinnerf29084d2019-03-20 02:20:13 +0100812}
813
814
Victor Stinner331a6a52019-05-27 16:39:22 +0200815PyStatus
816Py_PreInitializeFromArgs(const PyPreConfig *src_config, Py_ssize_t argc, wchar_t **argv)
Victor Stinner20004952019-03-26 02:31:11 +0100817{
Victor Stinner5ac27a52019-03-27 13:40:14 +0100818 _PyArgv args = {.use_bytes_argv = 0, .argc = argc, .wchar_argv = argv};
Victor Stinner70005ac2019-05-02 15:25:34 -0400819 return _Py_PreInitializeFromPyArgv(src_config, &args);
Victor Stinner20004952019-03-26 02:31:11 +0100820}
821
822
Victor Stinner331a6a52019-05-27 16:39:22 +0200823PyStatus
824Py_PreInitialize(const PyPreConfig *src_config)
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100825{
Victor Stinner70005ac2019-05-02 15:25:34 -0400826 return _Py_PreInitializeFromPyArgv(src_config, NULL);
Victor Stinnera6fbc4e2019-03-25 18:37:10 +0100827}
828
829
Victor Stinner331a6a52019-05-27 16:39:22 +0200830PyStatus
831_Py_PreInitializeFromConfig(const PyConfig *config,
832 const _PyArgv *args)
Victor Stinnerf29084d2019-03-20 02:20:13 +0100833{
Victor Stinner331a6a52019-05-27 16:39:22 +0200834 assert(config != NULL);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200835
Victor Stinner331a6a52019-05-27 16:39:22 +0200836 PyStatus status = _PyRuntime_Initialize();
837 if (_PyStatus_EXCEPTION(status)) {
838 return status;
Victor Stinner6d1c4672019-05-20 11:02:00 +0200839 }
840 _PyRuntimeState *runtime = &_PyRuntime;
841
Victor Stinnerd3b90412019-09-17 23:59:51 +0200842 if (runtime->preinitialized) {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200843 /* Already initialized: do nothing */
Victor Stinner331a6a52019-05-27 16:39:22 +0200844 return _PyStatus_OK();
Victor Stinner70005ac2019-05-02 15:25:34 -0400845 }
Victor Stinnercab5d072019-05-17 19:01:14 +0200846
Victor Stinner331a6a52019-05-27 16:39:22 +0200847 PyPreConfig preconfig;
Victor Stinner441b10c2019-09-28 04:28:35 +0200848
Victor Stinner3c30a762019-10-01 10:56:37 +0200849 _PyPreConfig_InitFromConfig(&preconfig, config);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200850
Victor Stinner331a6a52019-05-27 16:39:22 +0200851 if (!config->parse_argv) {
852 return Py_PreInitialize(&preconfig);
Victor Stinner6d1c4672019-05-20 11:02:00 +0200853 }
854 else if (args == NULL) {
Victor Stinnercab5d072019-05-17 19:01:14 +0200855 _PyArgv config_args = {
856 .use_bytes_argv = 0,
Victor Stinner331a6a52019-05-27 16:39:22 +0200857 .argc = config->argv.length,
858 .wchar_argv = config->argv.items};
Victor Stinner6d1c4672019-05-20 11:02:00 +0200859 return _Py_PreInitializeFromPyArgv(&preconfig, &config_args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200860 }
861 else {
Victor Stinner6d1c4672019-05-20 11:02:00 +0200862 return _Py_PreInitializeFromPyArgv(&preconfig, args);
Victor Stinnercab5d072019-05-17 19:01:14 +0200863 }
Victor Stinner7d2ef3e2019-03-06 00:36:56 +0100864}
865
866
Victor Stinner6d43f6f2019-01-22 21:18:05 +0100867/* Begin interpreter initialization
868 *
869 * On return, the first thread and interpreter state have been created,
870 * but the compiler, signal handling, multithreading and
871 * multiple interpreter support, and codec infrastructure are not yet
872 * available.
873 *
874 * The import system will support builtin and frozen modules only.
875 * The only supported io is writing to sys.stderr
876 *
877 * If any operation invoked by this function fails, a fatal error is
878 * issued and the function does not return.
879 *
880 * Any code invoked from this function should *not* assume it has access
881 * to the Python C API (unless the API is explicitly listed as being
882 * safe to call without calling Py_Initialize first)
883 */
Victor Stinner331a6a52019-05-27 16:39:22 +0200884static PyStatus
Victor Stinner5edcf262019-05-23 00:57:57 +0200885pyinit_core(_PyRuntimeState *runtime,
Victor Stinner331a6a52019-05-27 16:39:22 +0200886 const PyConfig *src_config,
Victor Stinnerb45d2592019-06-20 00:05:23 +0200887 PyThreadState **tstate_p)
Victor Stinner1dc6e392018-07-25 02:49:17 +0200888{
Victor Stinner331a6a52019-05-27 16:39:22 +0200889 PyStatus status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200890
Victor Stinner331a6a52019-05-27 16:39:22 +0200891 status = _Py_PreInitializeFromConfig(src_config, NULL);
892 if (_PyStatus_EXCEPTION(status)) {
893 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200894 }
895
Victor Stinner331a6a52019-05-27 16:39:22 +0200896 PyConfig config;
Victor Stinner8462a492019-10-01 12:06:16 +0200897 _PyConfig_InitCompatConfig(&config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200898
Victor Stinner331a6a52019-05-27 16:39:22 +0200899 status = _PyConfig_Copy(&config, src_config);
900 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200901 goto done;
902 }
903
Victor Stinner331a6a52019-05-27 16:39:22 +0200904 status = PyConfig_Read(&config);
905 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200906 goto done;
907 }
908
909 if (!runtime->core_initialized) {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200910 status = pyinit_config(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200911 }
912 else {
Victor Stinnerb45d2592019-06-20 00:05:23 +0200913 status = pyinit_core_reconfigure(runtime, tstate_p, &config);
Victor Stinner5edcf262019-05-23 00:57:57 +0200914 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200915 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner5edcf262019-05-23 00:57:57 +0200916 goto done;
917 }
918
919done:
Victor Stinner331a6a52019-05-27 16:39:22 +0200920 PyConfig_Clear(&config);
921 return status;
Victor Stinner1dc6e392018-07-25 02:49:17 +0200922}
923
Victor Stinner5ac27a52019-03-27 13:40:14 +0100924
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200925/* Py_Initialize() has already been called: update the main interpreter
926 configuration. Example of bpo-34008: Py_Main() called after
927 Py_Initialize(). */
Victor Stinner331a6a52019-05-27 16:39:22 +0200928static PyStatus
Victor Stinnerb0051362019-11-22 17:52:42 +0100929_Py_ReconfigureMainInterpreter(PyThreadState *tstate)
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200930{
Victor Stinnerb0051362019-11-22 17:52:42 +0100931 PyConfig *config = &tstate->interp->config;
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100932
Victor Stinner331a6a52019-05-27 16:39:22 +0200933 PyObject *argv = _PyWideStringList_AsList(&config->argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100934 if (argv == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200935 return _PyStatus_NO_MEMORY(); \
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100936 }
937
Victor Stinnerb0051362019-11-22 17:52:42 +0100938 int res = PyDict_SetItemString(tstate->interp->sysdict, "argv", argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +0100939 Py_DECREF(argv);
940 if (res < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +0200941 return _PyStatus_ERR("fail to set sys.argv");
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200942 }
Victor Stinner331a6a52019-05-27 16:39:22 +0200943 return _PyStatus_OK();
Victor Stinnerfb47bca2018-07-20 17:34:23 +0200944}
945
Victor Stinnerb0051362019-11-22 17:52:42 +0100946
947static PyStatus
948init_interp_main(PyThreadState *tstate)
949{
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100950 assert(!_PyErr_Occurred(tstate));
951
Victor Stinnerb0051362019-11-22 17:52:42 +0100952 PyStatus status;
953 int is_main_interp = _Py_IsMainInterpreter(tstate);
954 PyInterpreterState *interp = tstate->interp;
955 PyConfig *config = &interp->config;
956
957 if (!config->_install_importlib) {
958 /* Special mode for freeze_importlib: run with no import system
959 *
960 * This means anything which needs support from extension modules
961 * or pure Python code in the standard library won't work.
962 */
963 if (is_main_interp) {
964 interp->runtime->initialized = 1;
965 }
966 return _PyStatus_OK();
967 }
968
969 if (is_main_interp) {
970 if (_PyTime_Init() < 0) {
971 return _PyStatus_ERR("can't initialize time");
972 }
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100973 }
Victor Stinnerb0051362019-11-22 17:52:42 +0100974
Victor Stinner81fe5bd2019-12-06 02:43:30 +0100975 if (_PySys_InitMain(tstate) < 0) {
976 return _PyStatus_ERR("can't finish initializing sys");
Victor Stinnerb0051362019-11-22 17:52:42 +0100977 }
978
979 status = init_importlib_external(tstate);
980 if (_PyStatus_EXCEPTION(status)) {
981 return status;
982 }
983
984 if (is_main_interp) {
985 /* initialize the faulthandler module */
986 status = _PyFaulthandler_Init(config->faulthandler);
987 if (_PyStatus_EXCEPTION(status)) {
988 return status;
989 }
990 }
991
992 status = _PyUnicode_InitEncodings(tstate);
993 if (_PyStatus_EXCEPTION(status)) {
994 return status;
995 }
996
997 if (is_main_interp) {
998 if (config->install_signal_handlers) {
999 status = init_signals(tstate);
1000 if (_PyStatus_EXCEPTION(status)) {
1001 return status;
1002 }
1003 }
1004
1005 if (_PyTraceMalloc_Init(config->tracemalloc) < 0) {
1006 return _PyStatus_ERR("can't initialize tracemalloc");
1007 }
1008 }
1009
1010 status = init_sys_streams(tstate);
1011 if (_PyStatus_EXCEPTION(status)) {
1012 return status;
1013 }
1014
1015 status = init_set_builtins_open(tstate);
1016 if (_PyStatus_EXCEPTION(status)) {
1017 return status;
1018 }
1019
1020 status = add_main_module(interp);
1021 if (_PyStatus_EXCEPTION(status)) {
1022 return status;
1023 }
1024
1025 if (is_main_interp) {
1026 /* Initialize warnings. */
1027 PyObject *warnoptions = PySys_GetObject("warnoptions");
1028 if (warnoptions != NULL && PyList_Size(warnoptions) > 0)
1029 {
1030 PyObject *warnings_module = PyImport_ImportModule("warnings");
1031 if (warnings_module == NULL) {
1032 fprintf(stderr, "'import warnings' failed; traceback:\n");
1033 _PyErr_Print(tstate);
1034 }
1035 Py_XDECREF(warnings_module);
1036 }
1037
1038 interp->runtime->initialized = 1;
1039 }
1040
1041 if (config->site_import) {
1042 status = init_import_site();
1043 if (_PyStatus_EXCEPTION(status)) {
1044 return status;
1045 }
1046 }
1047
1048 if (is_main_interp) {
1049#ifndef MS_WINDOWS
1050 emit_stderr_warning_for_legacy_locale(interp->runtime);
1051#endif
1052 }
1053
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001054 assert(!_PyErr_Occurred(tstate));
1055
Victor Stinnerb0051362019-11-22 17:52:42 +01001056 return _PyStatus_OK();
1057}
1058
1059
Eric Snowc7ec9982017-05-23 23:00:52 -07001060/* Update interpreter state based on supplied configuration settings
1061 *
1062 * After calling this function, most of the restrictions on the interpreter
1063 * are lifted. The only remaining incomplete settings are those related
1064 * to the main module (sys.argv[0], __main__ metadata)
1065 *
1066 * Calling this when the interpreter is not initializing, is already
1067 * initialized or without a valid current thread state is a fatal error.
1068 * Other errors should be reported as normal Python exceptions with a
1069 * non-zero return code.
1070 */
Victor Stinner331a6a52019-05-27 16:39:22 +02001071static PyStatus
Victor Stinner01b1cc12019-11-20 02:27:56 +01001072pyinit_main(PyThreadState *tstate)
Eric Snow1abcf672017-05-23 21:46:51 -07001073{
Victor Stinnerb0051362019-11-22 17:52:42 +01001074 PyInterpreterState *interp = tstate->interp;
1075 if (!interp->runtime->core_initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001076 return _PyStatus_ERR("runtime core not initialized");
Eric Snowc7ec9982017-05-23 23:00:52 -07001077 }
Eric Snowc7ec9982017-05-23 23:00:52 -07001078
Victor Stinnerb0051362019-11-22 17:52:42 +01001079 if (interp->runtime->initialized) {
1080 return _Py_ReconfigureMainInterpreter(tstate);
Victor Stinnerfb47bca2018-07-20 17:34:23 +02001081 }
1082
Victor Stinnerb0051362019-11-22 17:52:42 +01001083 PyStatus status = init_interp_main(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001084 if (_PyStatus_EXCEPTION(status)) {
1085 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001086 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001087 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001088}
1089
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001090
Victor Stinner331a6a52019-05-27 16:39:22 +02001091PyStatus
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001092_Py_InitializeMain(void)
1093{
Victor Stinner331a6a52019-05-27 16:39:22 +02001094 PyStatus status = _PyRuntime_Initialize();
1095 if (_PyStatus_EXCEPTION(status)) {
1096 return status;
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001097 }
1098 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinnerb45d2592019-06-20 00:05:23 +02001099 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
Victor Stinner01b1cc12019-11-20 02:27:56 +01001100 return pyinit_main(tstate);
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001101}
1102
1103
Victor Stinner331a6a52019-05-27 16:39:22 +02001104PyStatus
1105Py_InitializeFromConfig(const PyConfig *config)
Eric Snow1abcf672017-05-23 21:46:51 -07001106{
Victor Stinner6d1c4672019-05-20 11:02:00 +02001107 if (config == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001108 return _PyStatus_ERR("initialization config is NULL");
Victor Stinner6d1c4672019-05-20 11:02:00 +02001109 }
1110
Victor Stinner331a6a52019-05-27 16:39:22 +02001111 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001112
Victor Stinner331a6a52019-05-27 16:39:22 +02001113 status = _PyRuntime_Initialize();
1114 if (_PyStatus_EXCEPTION(status)) {
1115 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001116 }
1117 _PyRuntimeState *runtime = &_PyRuntime;
1118
Victor Stinnerb45d2592019-06-20 00:05:23 +02001119 PyThreadState *tstate = NULL;
1120 status = pyinit_core(runtime, config, &tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001121 if (_PyStatus_EXCEPTION(status)) {
1122 return status;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001123 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02001124 config = &tstate->interp->config;
Victor Stinnerbc8ac6b2017-11-30 18:03:55 +01001125
Victor Stinner9ef5dca2019-05-16 17:38:16 +02001126 if (config->_init_main) {
Victor Stinner01b1cc12019-11-20 02:27:56 +01001127 status = pyinit_main(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +02001128 if (_PyStatus_EXCEPTION(status)) {
1129 return status;
Victor Stinner484f20d2019-03-27 02:04:16 +01001130 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001131 }
Victor Stinner484f20d2019-03-27 02:04:16 +01001132
Victor Stinner331a6a52019-05-27 16:39:22 +02001133 return _PyStatus_OK();
Victor Stinner5ac27a52019-03-27 13:40:14 +01001134}
1135
1136
Eric Snow1abcf672017-05-23 21:46:51 -07001137void
Nick Coghland6009512014-11-20 21:39:37 +10001138Py_InitializeEx(int install_sigs)
1139{
Victor Stinner331a6a52019-05-27 16:39:22 +02001140 PyStatus status;
Victor Stinner43125222019-04-24 18:23:53 +02001141
Victor Stinner331a6a52019-05-27 16:39:22 +02001142 status = _PyRuntime_Initialize();
1143 if (_PyStatus_EXCEPTION(status)) {
1144 Py_ExitStatusException(status);
Victor Stinner43125222019-04-24 18:23:53 +02001145 }
1146 _PyRuntimeState *runtime = &_PyRuntime;
1147
1148 if (runtime->initialized) {
Victor Stinner1dc6e392018-07-25 02:49:17 +02001149 /* bpo-33932: Calling Py_Initialize() twice does nothing. */
1150 return;
1151 }
1152
Victor Stinner331a6a52019-05-27 16:39:22 +02001153 PyConfig config;
Victor Stinner8462a492019-10-01 12:06:16 +02001154 _PyConfig_InitCompatConfig(&config);
Victor Stinner441b10c2019-09-28 04:28:35 +02001155
Victor Stinner1dc6e392018-07-25 02:49:17 +02001156 config.install_signal_handlers = install_sigs;
1157
Victor Stinner331a6a52019-05-27 16:39:22 +02001158 status = Py_InitializeFromConfig(&config);
1159 if (_PyStatus_EXCEPTION(status)) {
1160 Py_ExitStatusException(status);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001161 }
Nick Coghland6009512014-11-20 21:39:37 +10001162}
1163
1164void
1165Py_Initialize(void)
1166{
1167 Py_InitializeEx(1);
1168}
1169
1170
1171#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001172extern void _Py_dump_counts(FILE*);
Nick Coghland6009512014-11-20 21:39:37 +10001173#endif
1174
1175/* Flush stdout and stderr */
1176
1177static int
1178file_is_closed(PyObject *fobj)
1179{
1180 int r;
1181 PyObject *tmp = PyObject_GetAttrString(fobj, "closed");
1182 if (tmp == NULL) {
1183 PyErr_Clear();
1184 return 0;
1185 }
1186 r = PyObject_IsTrue(tmp);
1187 Py_DECREF(tmp);
1188 if (r < 0)
1189 PyErr_Clear();
1190 return r > 0;
1191}
1192
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001193static int
Nick Coghland6009512014-11-20 21:39:37 +10001194flush_std_files(void)
1195{
1196 PyObject *fout = _PySys_GetObjectId(&PyId_stdout);
1197 PyObject *ferr = _PySys_GetObjectId(&PyId_stderr);
1198 PyObject *tmp;
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001199 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001200
1201 if (fout != NULL && fout != Py_None && !file_is_closed(fout)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001202 tmp = _PyObject_CallMethodIdNoArgs(fout, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001203 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001204 PyErr_WriteUnraisable(fout);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001205 status = -1;
1206 }
Nick Coghland6009512014-11-20 21:39:37 +10001207 else
1208 Py_DECREF(tmp);
1209 }
1210
1211 if (ferr != NULL && ferr != Py_None && !file_is_closed(ferr)) {
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001212 tmp = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001213 if (tmp == NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001214 PyErr_Clear();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001215 status = -1;
1216 }
Nick Coghland6009512014-11-20 21:39:37 +10001217 else
1218 Py_DECREF(tmp);
1219 }
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001220
1221 return status;
Nick Coghland6009512014-11-20 21:39:37 +10001222}
1223
1224/* Undo the effect of Py_Initialize().
1225
1226 Beware: if multiple interpreter and/or thread states exist, these
1227 are not wiped out; only the current thread and interpreter state
1228 are deleted. But since everything else is deleted, those other
1229 interpreter and thread states should no longer be used.
1230
1231 (XXX We should do better, e.g. wipe out all interpreters and
1232 threads.)
1233
1234 Locking: as above.
1235
1236*/
1237
Victor Stinner7eee5be2019-11-20 10:38:34 +01001238
1239static void
1240finalize_interp_types(PyThreadState *tstate, int is_main_interp)
1241{
1242 if (is_main_interp) {
1243 /* Sundry finalizers */
Victor Stinner7eee5be2019-11-20 10:38:34 +01001244 _PyFrame_Fini();
Victor Stinner7eee5be2019-11-20 10:38:34 +01001245 _PyTuple_Fini();
1246 _PyList_Fini();
1247 _PySet_Fini();
1248 _PyBytes_Fini();
1249 _PyLong_Fini();
1250 _PyFloat_Fini();
1251 _PyDict_Fini();
1252 _PySlice_Fini();
1253 }
1254
1255 _PyWarnings_Fini(tstate->interp);
1256
1257 if (is_main_interp) {
1258 _Py_HashRandomization_Fini();
1259 _PyArg_Fini();
1260 _PyAsyncGen_Fini();
1261 _PyContext_Fini();
Victor Stinner3d483342019-11-22 12:27:50 +01001262 }
Victor Stinner7eee5be2019-11-20 10:38:34 +01001263
Victor Stinner3d483342019-11-22 12:27:50 +01001264 /* Cleanup Unicode implementation */
1265 _PyUnicode_Fini(tstate);
1266
1267 if (is_main_interp) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001268 _Py_ClearFileSystemEncoding();
1269 }
1270}
1271
1272
1273static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001274finalize_interp_clear(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001275{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001276 int is_main_interp = _Py_IsMainInterpreter(tstate);
1277
Victor Stinner7eee5be2019-11-20 10:38:34 +01001278 /* Clear interpreter state and all thread states */
1279 PyInterpreterState_Clear(tstate->interp);
1280
Pablo Galindoac0e1c22019-12-04 11:51:03 +00001281 /* Trigger a GC collection on subinterpreters*/
1282 if (!is_main_interp) {
1283 _PyGC_CollectNoFail();
1284 }
1285
Victor Stinner7eee5be2019-11-20 10:38:34 +01001286 finalize_interp_types(tstate, is_main_interp);
1287
1288 if (is_main_interp) {
1289 /* XXX Still allocated:
1290 - various static ad-hoc pointers to interned strings
1291 - int and float free list blocks
1292 - whatever various modules and libraries allocate
1293 */
1294
1295 PyGrammar_RemoveAccelerators(&_PyParser_Grammar);
1296
1297 _PyExc_Fini();
Victor Stinner7eee5be2019-11-20 10:38:34 +01001298 }
Victor Stinner72474072019-11-20 12:25:50 +01001299
1300 _PyGC_Fini(tstate);
Victor Stinner7eee5be2019-11-20 10:38:34 +01001301}
1302
1303
1304static void
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001305finalize_interp_delete(PyThreadState *tstate)
Victor Stinner7eee5be2019-11-20 10:38:34 +01001306{
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001307 if (_Py_IsMainInterpreter(tstate)) {
Victor Stinner7eee5be2019-11-20 10:38:34 +01001308 /* Cleanup auto-thread-state */
1309 _PyGILState_Fini(tstate);
1310 }
1311
Victor Stinner7eee5be2019-11-20 10:38:34 +01001312 PyInterpreterState_Delete(tstate->interp);
1313}
1314
1315
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001316int
1317Py_FinalizeEx(void)
Nick Coghland6009512014-11-20 21:39:37 +10001318{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001319 int status = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001320
Victor Stinner8e91c242019-04-24 17:24:01 +02001321 _PyRuntimeState *runtime = &_PyRuntime;
1322 if (!runtime->initialized) {
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001323 return status;
Victor Stinner8e91c242019-04-24 17:24:01 +02001324 }
Nick Coghland6009512014-11-20 21:39:37 +10001325
Victor Stinnere225beb2019-06-03 18:14:24 +02001326 /* Get current thread state and interpreter pointer */
1327 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
1328 PyInterpreterState *interp = tstate->interp;
Victor Stinner8e91c242019-04-24 17:24:01 +02001329
Victor Stinnerb45d2592019-06-20 00:05:23 +02001330 // Wrap up existing "threading"-module-created, non-daemon threads.
1331 wait_for_thread_shutdown(tstate);
1332
1333 // Make any remaining pending calls.
1334 _Py_FinishPendingCalls(runtime);
1335
Nick Coghland6009512014-11-20 21:39:37 +10001336 /* The interpreter is still entirely intact at this point, and the
1337 * exit funcs may be relying on that. In particular, if some thread
1338 * or exit func is still waiting to do an import, the import machinery
1339 * expects Py_IsInitialized() to return true. So don't say the
Eric Snow842a2f02019-03-15 15:47:51 -06001340 * runtime is uninitialized until after the exit funcs have run.
Nick Coghland6009512014-11-20 21:39:37 +10001341 * Note that Threading.py uses an exit func to do a join on all the
1342 * threads created thru it, so this also protects pending imports in
1343 * the threads created via Threading.
1344 */
Nick Coghland6009512014-11-20 21:39:37 +10001345
Victor Stinnerb45d2592019-06-20 00:05:23 +02001346 call_py_exitfuncs(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001347
Victor Stinnerda273412017-12-15 01:46:02 +01001348 /* Copy the core config, PyInterpreterState_Delete() free
1349 the core config memory */
Victor Stinner5d862462017-12-19 11:35:58 +01001350#ifdef Py_REF_DEBUG
Victor Stinner331a6a52019-05-27 16:39:22 +02001351 int show_ref_count = interp->config.show_ref_count;
Victor Stinner5d862462017-12-19 11:35:58 +01001352#endif
1353#ifdef Py_TRACE_REFS
Victor Stinner331a6a52019-05-27 16:39:22 +02001354 int dump_refs = interp->config.dump_refs;
Victor Stinner5d862462017-12-19 11:35:58 +01001355#endif
1356#ifdef WITH_PYMALLOC
Victor Stinner331a6a52019-05-27 16:39:22 +02001357 int malloc_stats = interp->config.malloc_stats;
Victor Stinner5d862462017-12-19 11:35:58 +01001358#endif
Victor Stinner6bf992a2017-12-06 17:26:10 +01001359
Nick Coghland6009512014-11-20 21:39:37 +10001360 /* Remaining threads (e.g. daemon threads) will automatically exit
1361 after taking the GIL (in PyEval_RestoreThread()). */
Victor Stinner8e91c242019-04-24 17:24:01 +02001362 runtime->finalizing = tstate;
1363 runtime->initialized = 0;
1364 runtime->core_initialized = 0;
Nick Coghland6009512014-11-20 21:39:37 +10001365
Victor Stinnere0deff32015-03-24 13:46:18 +01001366 /* Flush sys.stdout and sys.stderr */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001367 if (flush_std_files() < 0) {
1368 status = -1;
1369 }
Nick Coghland6009512014-11-20 21:39:37 +10001370
1371 /* Disable signal handling */
1372 PyOS_FiniInterrupts();
1373
1374 /* Collect garbage. This may call finalizers; it's nice to call these
1375 * before all modules are destroyed.
1376 * XXX If a __del__ or weakref callback is triggered here, and tries to
1377 * XXX import a module, bad things can happen, because Python no
1378 * XXX longer believes it's initialized.
1379 * XXX Fatal Python error: Interpreter not initialized (version mismatch?)
1380 * XXX is easy to provoke that way. I've also seen, e.g.,
1381 * XXX Exception exceptions.ImportError: 'No module named sha'
1382 * XXX in <function callback at 0x008F5718> ignored
1383 * XXX but I'm unclear on exactly how that one happens. In any case,
1384 * XXX I haven't seen a real-life report of either of these.
1385 */
Łukasz Langafef7e942016-09-09 21:47:46 -07001386 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001387#ifdef COUNT_ALLOCS
1388 /* With COUNT_ALLOCS, it helps to run GC multiple times:
1389 each collection might release some types from the type
1390 list, so they become garbage. */
Łukasz Langafef7e942016-09-09 21:47:46 -07001391 while (_PyGC_CollectIfEnabled() > 0)
Nick Coghland6009512014-11-20 21:39:37 +10001392 /* nothing */;
1393#endif
Eric Snowdae02762017-09-14 00:35:58 -07001394
Steve Dowerb82e17e2019-05-23 08:45:22 -07001395 /* Clear all loghooks */
1396 /* We want minimal exposure of this function, so define the extern
1397 * here. The linker should discover the correct function without
1398 * exporting a symbol. */
1399 extern void _PySys_ClearAuditHooks(void);
1400 _PySys_ClearAuditHooks();
1401
Nick Coghland6009512014-11-20 21:39:37 +10001402 /* Destroy all modules */
Victor Stinner987a0dc2019-06-19 10:36:10 +02001403 _PyImport_Cleanup(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001404
Inada Naoki91234a12019-06-03 21:30:58 +09001405 /* Print debug stats if any */
1406 _PyEval_Fini();
1407
Victor Stinnere0deff32015-03-24 13:46:18 +01001408 /* Flush sys.stdout and sys.stderr (again, in case more was printed) */
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001409 if (flush_std_files() < 0) {
1410 status = -1;
1411 }
Nick Coghland6009512014-11-20 21:39:37 +10001412
1413 /* Collect final garbage. This disposes of cycles created by
1414 * class definitions, for example.
1415 * XXX This is disabled because it caused too many problems. If
1416 * XXX a __del__ or weakref callback triggers here, Python code has
1417 * XXX a hard time running, because even the sys module has been
1418 * XXX cleared out (sys.stdout is gone, sys.excepthook is gone, etc).
1419 * XXX One symptom is a sequence of information-free messages
1420 * XXX coming from threads (if a __del__ or callback is invoked,
1421 * XXX other threads can execute too, and any exception they encounter
1422 * XXX triggers a comedy of errors as subsystem after subsystem
1423 * XXX fails to find what it *expects* to find in sys to help report
1424 * XXX the exception and consequent unexpected failures). I've also
1425 * XXX seen segfaults then, after adding print statements to the
1426 * XXX Python code getting called.
1427 */
1428#if 0
Łukasz Langafef7e942016-09-09 21:47:46 -07001429 _PyGC_CollectIfEnabled();
Nick Coghland6009512014-11-20 21:39:37 +10001430#endif
1431
1432 /* Disable tracemalloc after all Python objects have been destroyed,
1433 so it is possible to use tracemalloc in objects destructor. */
1434 _PyTraceMalloc_Fini();
1435
1436 /* Destroy the database used by _PyImport_{Fixup,Find}Extension */
1437 _PyImport_Fini();
1438
1439 /* Cleanup typeobject.c's internal caches. */
1440 _PyType_Fini();
1441
1442 /* unload faulthandler module */
1443 _PyFaulthandler_Fini();
1444
1445 /* Debugging stuff */
1446#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +00001447 _Py_dump_counts(stderr);
Nick Coghland6009512014-11-20 21:39:37 +10001448#endif
1449 /* dump hash stats */
1450 _PyHash_Fini();
1451
Eric Snowdae02762017-09-14 00:35:58 -07001452#ifdef Py_REF_DEBUG
Victor Stinnerda273412017-12-15 01:46:02 +01001453 if (show_ref_count) {
Victor Stinner25420fe2017-11-20 18:12:22 -08001454 _PyDebug_PrintTotalRefs();
1455 }
Eric Snowdae02762017-09-14 00:35:58 -07001456#endif
Nick Coghland6009512014-11-20 21:39:37 +10001457
1458#ifdef Py_TRACE_REFS
1459 /* Display all objects still alive -- this can invoke arbitrary
1460 * __repr__ overrides, so requires a mostly-intact interpreter.
1461 * Alas, a lot of stuff may still be alive now that will be cleaned
1462 * up later.
1463 */
Victor Stinnerda273412017-12-15 01:46:02 +01001464 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001465 _Py_PrintReferences(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001466 }
Nick Coghland6009512014-11-20 21:39:37 +10001467#endif /* Py_TRACE_REFS */
1468
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001469 finalize_interp_clear(tstate);
1470 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001471
1472#ifdef Py_TRACE_REFS
1473 /* Display addresses (& refcnts) of all objects still alive.
1474 * An address can be used to find the repr of the object, printed
1475 * above by _Py_PrintReferences.
1476 */
Victor Stinnerda273412017-12-15 01:46:02 +01001477 if (dump_refs) {
Nick Coghland6009512014-11-20 21:39:37 +10001478 _Py_PrintReferenceAddresses(stderr);
Victor Stinner6bf992a2017-12-06 17:26:10 +01001479 }
Nick Coghland6009512014-11-20 21:39:37 +10001480#endif /* Py_TRACE_REFS */
Victor Stinner34be8072016-03-14 12:04:26 +01001481#ifdef WITH_PYMALLOC
Victor Stinnerda273412017-12-15 01:46:02 +01001482 if (malloc_stats) {
Victor Stinner6bf992a2017-12-06 17:26:10 +01001483 _PyObject_DebugMallocStats(stderr);
Victor Stinner34be8072016-03-14 12:04:26 +01001484 }
Nick Coghland6009512014-11-20 21:39:37 +10001485#endif
1486
Victor Stinner8e91c242019-04-24 17:24:01 +02001487 call_ll_exitfuncs(runtime);
Victor Stinner9316ee42017-11-25 03:17:57 +01001488
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001489 _PyRuntime_Finalize();
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001490 return status;
1491}
1492
1493void
1494Py_Finalize(void)
1495{
1496 Py_FinalizeEx();
Nick Coghland6009512014-11-20 21:39:37 +10001497}
1498
Victor Stinnerb0051362019-11-22 17:52:42 +01001499
Nick Coghland6009512014-11-20 21:39:37 +10001500/* Create and initialize a new interpreter and thread, and return the
1501 new thread. This requires that Py_Initialize() has been called
1502 first.
1503
1504 Unsuccessful initialization yields a NULL pointer. Note that *no*
1505 exception information is available even in this case -- the
1506 exception information is held in the thread, and there is no
1507 thread.
1508
1509 Locking: as above.
1510
1511*/
1512
Victor Stinner331a6a52019-05-27 16:39:22 +02001513static PyStatus
Victor Stinnera7368ac2017-11-15 18:11:45 -08001514new_interpreter(PyThreadState **tstate_p)
Nick Coghland6009512014-11-20 21:39:37 +10001515{
Victor Stinner331a6a52019-05-27 16:39:22 +02001516 PyStatus status;
Nick Coghland6009512014-11-20 21:39:37 +10001517
Victor Stinner331a6a52019-05-27 16:39:22 +02001518 status = _PyRuntime_Initialize();
1519 if (_PyStatus_EXCEPTION(status)) {
1520 return status;
Victor Stinner43125222019-04-24 18:23:53 +02001521 }
1522 _PyRuntimeState *runtime = &_PyRuntime;
1523
1524 if (!runtime->initialized) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001525 return _PyStatus_ERR("Py_Initialize must be called first");
Victor Stinnera7368ac2017-11-15 18:11:45 -08001526 }
Nick Coghland6009512014-11-20 21:39:37 +10001527
Victor Stinner8a1be612016-03-14 22:07:55 +01001528 /* Issue #10915, #15751: The GIL API doesn't work with multiple
1529 interpreters: disable PyGILState_Check(). */
1530 _PyGILState_check_enabled = 0;
1531
Victor Stinner43125222019-04-24 18:23:53 +02001532 PyInterpreterState *interp = PyInterpreterState_New();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001533 if (interp == NULL) {
1534 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001535 return _PyStatus_OK();
Victor Stinnera7368ac2017-11-15 18:11:45 -08001536 }
Nick Coghland6009512014-11-20 21:39:37 +10001537
Victor Stinner43125222019-04-24 18:23:53 +02001538 PyThreadState *tstate = PyThreadState_New(interp);
Nick Coghland6009512014-11-20 21:39:37 +10001539 if (tstate == NULL) {
1540 PyInterpreterState_Delete(interp);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001541 *tstate_p = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001542 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001543 }
1544
Victor Stinner43125222019-04-24 18:23:53 +02001545 PyThreadState *save_tstate = PyThreadState_Swap(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001546
Eric Snow1abcf672017-05-23 21:46:51 -07001547 /* Copy the current interpreter config into the new interpreter */
Victor Stinner331a6a52019-05-27 16:39:22 +02001548 PyConfig *config;
Eric Snow1abcf672017-05-23 21:46:51 -07001549 if (save_tstate != NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001550 config = &save_tstate->interp->config;
Eric Snow1abcf672017-05-23 21:46:51 -07001551 } else {
1552 /* No current thread state, copy from the main interpreter */
1553 PyInterpreterState *main_interp = PyInterpreterState_Main();
Victor Stinner331a6a52019-05-27 16:39:22 +02001554 config = &main_interp->config;
Victor Stinnerda273412017-12-15 01:46:02 +01001555 }
1556
Victor Stinner331a6a52019-05-27 16:39:22 +02001557 status = _PyConfig_Copy(&interp->config, config);
1558 if (_PyStatus_EXCEPTION(status)) {
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001559 goto error;
Victor Stinnerda273412017-12-15 01:46:02 +01001560 }
Eric Snow1abcf672017-05-23 21:46:51 -07001561
Victor Stinnerd863ade2019-12-06 03:37:07 +01001562 status = pycore_interp_init(tstate);
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001563 if (_PyStatus_EXCEPTION(status)) {
1564 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001565 }
1566
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001567 status = init_interp_main(tstate);
1568 if (_PyStatus_EXCEPTION(status)) {
1569 goto error;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001570 }
Nick Coghland6009512014-11-20 21:39:37 +10001571
Victor Stinnera7368ac2017-11-15 18:11:45 -08001572 *tstate_p = tstate;
Victor Stinner331a6a52019-05-27 16:39:22 +02001573 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001574
Victor Stinner81fe5bd2019-12-06 02:43:30 +01001575error:
Victor Stinnerb0051362019-11-22 17:52:42 +01001576 *tstate_p = NULL;
1577
1578 /* Oops, it didn't work. Undo it all. */
Nick Coghland6009512014-11-20 21:39:37 +10001579 PyErr_PrintEx(0);
1580 PyThreadState_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001581 PyThreadState_Delete(tstate);
1582 PyInterpreterState_Delete(interp);
Victor Stinner9da74302019-11-20 11:17:17 +01001583 PyThreadState_Swap(save_tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001584
Victor Stinnerb0051362019-11-22 17:52:42 +01001585 return status;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001586}
1587
1588PyThreadState *
1589Py_NewInterpreter(void)
1590{
Stéphane Wirtel9e06d2b2019-03-18 17:10:29 +01001591 PyThreadState *tstate = NULL;
Victor Stinner331a6a52019-05-27 16:39:22 +02001592 PyStatus status = new_interpreter(&tstate);
1593 if (_PyStatus_EXCEPTION(status)) {
1594 Py_ExitStatusException(status);
Victor Stinnera7368ac2017-11-15 18:11:45 -08001595 }
1596 return tstate;
1597
Nick Coghland6009512014-11-20 21:39:37 +10001598}
1599
1600/* Delete an interpreter and its last thread. This requires that the
1601 given thread state is current, that the thread has no remaining
1602 frames, and that it is its interpreter's only remaining thread.
1603 It is a fatal error to violate these constraints.
1604
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001605 (Py_FinalizeEx() doesn't have these constraints -- it zaps
Nick Coghland6009512014-11-20 21:39:37 +10001606 everything, regardless.)
1607
1608 Locking: as above.
1609
1610*/
1611
1612void
1613Py_EndInterpreter(PyThreadState *tstate)
1614{
1615 PyInterpreterState *interp = tstate->interp;
1616
Victor Stinnerb45d2592019-06-20 00:05:23 +02001617 if (tstate != _PyThreadState_GET()) {
Nick Coghland6009512014-11-20 21:39:37 +10001618 Py_FatalError("Py_EndInterpreter: thread is not current");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001619 }
1620 if (tstate->frame != NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001621 Py_FatalError("Py_EndInterpreter: thread still has a frame");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001622 }
Eric Snow5be45a62019-03-08 22:47:07 -07001623 interp->finalizing = 1;
Nick Coghland6009512014-11-20 21:39:37 +10001624
Eric Snow842a2f02019-03-15 15:47:51 -06001625 // Wrap up existing "threading"-module-created, non-daemon threads.
Victor Stinnerb45d2592019-06-20 00:05:23 +02001626 wait_for_thread_shutdown(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001627
Victor Stinnerb45d2592019-06-20 00:05:23 +02001628 call_py_exitfuncs(tstate);
Marcel Plch776407f2017-12-20 11:17:58 +01001629
Victor Stinnerb45d2592019-06-20 00:05:23 +02001630 if (tstate != interp->tstate_head || tstate->next != NULL) {
Nick Coghland6009512014-11-20 21:39:37 +10001631 Py_FatalError("Py_EndInterpreter: not the last thread");
Victor Stinnerb45d2592019-06-20 00:05:23 +02001632 }
Nick Coghland6009512014-11-20 21:39:37 +10001633
Victor Stinner987a0dc2019-06-19 10:36:10 +02001634 _PyImport_Cleanup(tstate);
Victor Stinnerb93f31f2019-11-20 18:39:12 +01001635 finalize_interp_clear(tstate);
1636 finalize_interp_delete(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10001637}
1638
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001639/* Add the __main__ module */
Nick Coghland6009512014-11-20 21:39:37 +10001640
Victor Stinner331a6a52019-05-27 16:39:22 +02001641static PyStatus
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001642add_main_module(PyInterpreterState *interp)
Nick Coghland6009512014-11-20 21:39:37 +10001643{
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001644 PyObject *m, *d, *loader, *ann_dict;
Nick Coghland6009512014-11-20 21:39:37 +10001645 m = PyImport_AddModule("__main__");
1646 if (m == NULL)
Victor Stinner331a6a52019-05-27 16:39:22 +02001647 return _PyStatus_ERR("can't create __main__ module");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001648
Nick Coghland6009512014-11-20 21:39:37 +10001649 d = PyModule_GetDict(m);
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001650 ann_dict = PyDict_New();
1651 if ((ann_dict == NULL) ||
1652 (PyDict_SetItemString(d, "__annotations__", ann_dict) < 0)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001653 return _PyStatus_ERR("Failed to initialize __main__.__annotations__");
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001654 }
1655 Py_DECREF(ann_dict);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001656
Nick Coghland6009512014-11-20 21:39:37 +10001657 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
1658 PyObject *bimod = PyImport_ImportModule("builtins");
1659 if (bimod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001660 return _PyStatus_ERR("Failed to retrieve builtins module");
Nick Coghland6009512014-11-20 21:39:37 +10001661 }
1662 if (PyDict_SetItemString(d, "__builtins__", bimod) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001663 return _PyStatus_ERR("Failed to initialize __main__.__builtins__");
Nick Coghland6009512014-11-20 21:39:37 +10001664 }
1665 Py_DECREF(bimod);
1666 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001667
Nick Coghland6009512014-11-20 21:39:37 +10001668 /* Main is a little special - imp.is_builtin("__main__") will return
1669 * False, but BuiltinImporter is still the most appropriate initial
1670 * setting for its __loader__ attribute. A more suitable value will
1671 * be set if __main__ gets further initialized later in the startup
1672 * process.
1673 */
1674 loader = PyDict_GetItemString(d, "__loader__");
1675 if (loader == NULL || loader == Py_None) {
1676 PyObject *loader = PyObject_GetAttrString(interp->importlib,
1677 "BuiltinImporter");
1678 if (loader == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001679 return _PyStatus_ERR("Failed to retrieve BuiltinImporter");
Nick Coghland6009512014-11-20 21:39:37 +10001680 }
1681 if (PyDict_SetItemString(d, "__loader__", loader) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001682 return _PyStatus_ERR("Failed to initialize __main__.__loader__");
Nick Coghland6009512014-11-20 21:39:37 +10001683 }
1684 Py_DECREF(loader);
1685 }
Victor Stinner331a6a52019-05-27 16:39:22 +02001686 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001687}
1688
Nick Coghland6009512014-11-20 21:39:37 +10001689/* Import the site module (not into __main__ though) */
1690
Victor Stinner331a6a52019-05-27 16:39:22 +02001691static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001692init_import_site(void)
Nick Coghland6009512014-11-20 21:39:37 +10001693{
1694 PyObject *m;
1695 m = PyImport_ImportModule("site");
1696 if (m == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001697 return _PyStatus_ERR("Failed to import the site module");
Nick Coghland6009512014-11-20 21:39:37 +10001698 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08001699 Py_DECREF(m);
Victor Stinner331a6a52019-05-27 16:39:22 +02001700 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10001701}
1702
Victor Stinner874dbe82015-09-04 17:29:57 +02001703/* Check if a file descriptor is valid or not.
1704 Return 0 if the file descriptor is invalid, return non-zero otherwise. */
1705static int
1706is_valid_fd(int fd)
1707{
Victor Stinner3092d6b2019-04-17 18:09:12 +02001708/* dup() is faster than fstat(): fstat() can require input/output operations,
1709 whereas dup() doesn't. There is a low risk of EMFILE/ENFILE at Python
1710 startup. Problem: dup() doesn't check if the file descriptor is valid on
1711 some platforms.
1712
1713 bpo-30225: On macOS Tiger, when stdout is redirected to a pipe and the other
1714 side of the pipe is closed, dup(1) succeed, whereas fstat(1, &st) fails with
1715 EBADF. FreeBSD has similar issue (bpo-32849).
1716
1717 Only use dup() on platforms where dup() is enough to detect invalid FD in
1718 corner cases: on Linux and Windows (bpo-32849). */
1719#if defined(__linux__) || defined(MS_WINDOWS)
1720 if (fd < 0) {
1721 return 0;
1722 }
1723 int fd2;
1724
1725 _Py_BEGIN_SUPPRESS_IPH
1726 fd2 = dup(fd);
1727 if (fd2 >= 0) {
1728 close(fd2);
1729 }
1730 _Py_END_SUPPRESS_IPH
1731
1732 return (fd2 >= 0);
1733#else
Victor Stinner1c4670e2017-05-04 00:45:56 +02001734 struct stat st;
1735 return (fstat(fd, &st) == 0);
Victor Stinner1c4670e2017-05-04 00:45:56 +02001736#endif
Victor Stinner874dbe82015-09-04 17:29:57 +02001737}
1738
1739/* returns Py_None if the fd is not valid */
Nick Coghland6009512014-11-20 21:39:37 +10001740static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02001741create_stdio(const PyConfig *config, PyObject* io,
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001742 int fd, int write_mode, const char* name,
Victor Stinner709d23d2019-05-02 14:56:30 -04001743 const wchar_t* encoding, const wchar_t* errors)
Nick Coghland6009512014-11-20 21:39:37 +10001744{
1745 PyObject *buf = NULL, *stream = NULL, *text = NULL, *raw = NULL, *res;
1746 const char* mode;
1747 const char* newline;
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001748 PyObject *line_buffering, *write_through;
Nick Coghland6009512014-11-20 21:39:37 +10001749 int buffering, isatty;
1750 _Py_IDENTIFIER(open);
1751 _Py_IDENTIFIER(isatty);
1752 _Py_IDENTIFIER(TextIOWrapper);
1753 _Py_IDENTIFIER(mode);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001754 const int buffered_stdio = config->buffered_stdio;
Nick Coghland6009512014-11-20 21:39:37 +10001755
Victor Stinner874dbe82015-09-04 17:29:57 +02001756 if (!is_valid_fd(fd))
1757 Py_RETURN_NONE;
1758
Nick Coghland6009512014-11-20 21:39:37 +10001759 /* stdin is always opened in buffered mode, first because it shouldn't
1760 make a difference in common use cases, second because TextIOWrapper
1761 depends on the presence of a read1() method which only exists on
1762 buffered streams.
1763 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001764 if (!buffered_stdio && write_mode)
Nick Coghland6009512014-11-20 21:39:37 +10001765 buffering = 0;
1766 else
1767 buffering = -1;
1768 if (write_mode)
1769 mode = "wb";
1770 else
1771 mode = "rb";
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001772 buf = _PyObject_CallMethodId(io, &PyId_open, "isiOOOO",
Nick Coghland6009512014-11-20 21:39:37 +10001773 fd, mode, buffering,
Martin Panterb4ce1fc2015-11-30 03:18:29 +00001774 Py_None, Py_None, /* encoding, errors */
Serhiy Storchaka1f21eaa2019-09-01 12:16:51 +03001775 Py_None, Py_False); /* newline, closefd */
Nick Coghland6009512014-11-20 21:39:37 +10001776 if (buf == NULL)
1777 goto error;
1778
1779 if (buffering) {
1780 _Py_IDENTIFIER(raw);
1781 raw = _PyObject_GetAttrId(buf, &PyId_raw);
1782 if (raw == NULL)
1783 goto error;
1784 }
1785 else {
1786 raw = buf;
1787 Py_INCREF(raw);
1788 }
1789
Steve Dower39294992016-08-30 21:22:36 -07001790#ifdef MS_WINDOWS
1791 /* Windows console IO is always UTF-8 encoded */
1792 if (PyWindowsConsoleIO_Check(raw))
Victor Stinner709d23d2019-05-02 14:56:30 -04001793 encoding = L"utf-8";
Steve Dower39294992016-08-30 21:22:36 -07001794#endif
1795
Nick Coghland6009512014-11-20 21:39:37 +10001796 text = PyUnicode_FromString(name);
1797 if (text == NULL || _PyObject_SetAttrId(raw, &PyId_name, text) < 0)
1798 goto error;
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001799 res = _PyObject_CallMethodIdNoArgs(raw, &PyId_isatty);
Nick Coghland6009512014-11-20 21:39:37 +10001800 if (res == NULL)
1801 goto error;
1802 isatty = PyObject_IsTrue(res);
1803 Py_DECREF(res);
1804 if (isatty == -1)
1805 goto error;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001806 if (!buffered_stdio)
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001807 write_through = Py_True;
1808 else
1809 write_through = Py_False;
Victor Stinnerfbca9082018-08-30 00:50:45 +02001810 if (isatty && buffered_stdio)
Nick Coghland6009512014-11-20 21:39:37 +10001811 line_buffering = Py_True;
1812 else
1813 line_buffering = Py_False;
1814
1815 Py_CLEAR(raw);
1816 Py_CLEAR(text);
1817
1818#ifdef MS_WINDOWS
1819 /* sys.stdin: enable universal newline mode, translate "\r\n" and "\r"
1820 newlines to "\n".
1821 sys.stdout and sys.stderr: translate "\n" to "\r\n". */
1822 newline = NULL;
1823#else
1824 /* sys.stdin: split lines at "\n".
1825 sys.stdout and sys.stderr: don't translate newlines (use "\n"). */
1826 newline = "\n";
1827#endif
1828
Victor Stinner709d23d2019-05-02 14:56:30 -04001829 PyObject *encoding_str = PyUnicode_FromWideChar(encoding, -1);
1830 if (encoding_str == NULL) {
1831 Py_CLEAR(buf);
1832 goto error;
1833 }
1834
1835 PyObject *errors_str = PyUnicode_FromWideChar(errors, -1);
1836 if (errors_str == NULL) {
1837 Py_CLEAR(buf);
1838 Py_CLEAR(encoding_str);
1839 goto error;
1840 }
1841
1842 stream = _PyObject_CallMethodId(io, &PyId_TextIOWrapper, "OOOsOO",
1843 buf, encoding_str, errors_str,
Serhiy Storchaka77732be2017-10-04 20:25:40 +03001844 newline, line_buffering, write_through);
Nick Coghland6009512014-11-20 21:39:37 +10001845 Py_CLEAR(buf);
Victor Stinner709d23d2019-05-02 14:56:30 -04001846 Py_CLEAR(encoding_str);
1847 Py_CLEAR(errors_str);
Nick Coghland6009512014-11-20 21:39:37 +10001848 if (stream == NULL)
1849 goto error;
1850
1851 if (write_mode)
1852 mode = "w";
1853 else
1854 mode = "r";
1855 text = PyUnicode_FromString(mode);
1856 if (!text || _PyObject_SetAttrId(stream, &PyId_mode, text) < 0)
1857 goto error;
1858 Py_CLEAR(text);
1859 return stream;
1860
1861error:
1862 Py_XDECREF(buf);
1863 Py_XDECREF(stream);
1864 Py_XDECREF(text);
1865 Py_XDECREF(raw);
Nick Coghland6009512014-11-20 21:39:37 +10001866
Victor Stinner874dbe82015-09-04 17:29:57 +02001867 if (PyErr_ExceptionMatches(PyExc_OSError) && !is_valid_fd(fd)) {
1868 /* Issue #24891: the file descriptor was closed after the first
1869 is_valid_fd() check was called. Ignore the OSError and set the
1870 stream to None. */
1871 PyErr_Clear();
1872 Py_RETURN_NONE;
1873 }
1874 return NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001875}
1876
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001877/* Set builtins.open to io.OpenWrapper */
1878static PyStatus
1879init_set_builtins_open(PyThreadState *tstate)
1880{
1881 PyObject *iomod = NULL, *wrapper;
1882 PyObject *bimod = NULL;
1883 PyStatus res = _PyStatus_OK();
1884
1885 if (!(iomod = PyImport_ImportModule("io"))) {
1886 goto error;
1887 }
1888
1889 if (!(bimod = PyImport_ImportModule("builtins"))) {
1890 goto error;
1891 }
1892
1893 if (!(wrapper = PyObject_GetAttrString(iomod, "OpenWrapper"))) {
1894 goto error;
1895 }
1896
1897 /* Set builtins.open */
1898 if (PyObject_SetAttrString(bimod, "open", wrapper) == -1) {
1899 Py_DECREF(wrapper);
1900 goto error;
1901 }
1902 Py_DECREF(wrapper);
1903 goto done;
1904
1905error:
1906 res = _PyStatus_ERR("can't initialize io.open");
1907
1908done:
1909 Py_XDECREF(bimod);
1910 Py_XDECREF(iomod);
1911 return res;
1912}
1913
1914
Nick Coghland6009512014-11-20 21:39:37 +10001915/* Initialize sys.stdin, stdout, stderr and builtins.open */
Victor Stinner331a6a52019-05-27 16:39:22 +02001916static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02001917init_sys_streams(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10001918{
Victor Stinnere0c9ab82019-11-22 16:19:14 +01001919 PyObject *iomod = NULL;
Nick Coghland6009512014-11-20 21:39:37 +10001920 PyObject *m;
1921 PyObject *std = NULL;
Victor Stinnera7368ac2017-11-15 18:11:45 -08001922 int fd;
Nick Coghland6009512014-11-20 21:39:37 +10001923 PyObject * encoding_attr;
Victor Stinner331a6a52019-05-27 16:39:22 +02001924 PyStatus res = _PyStatus_OK();
Victor Stinnerb45d2592019-06-20 00:05:23 +02001925 const PyConfig *config = &tstate->interp->config;
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001926
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001927 /* Check that stdin is not a directory
1928 Using shell redirection, you can redirect stdin to a directory,
1929 crashing the Python interpreter. Catch this common mistake here
1930 and output a useful error message. Note that under MS Windows,
1931 the shell already prevents that. */
1932#ifndef MS_WINDOWS
1933 struct _Py_stat_struct sb;
1934 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
1935 S_ISDIR(sb.st_mode)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02001936 return _PyStatus_ERR("<stdin> is a directory, cannot continue");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001937 }
1938#endif
1939
Nick Coghland6009512014-11-20 21:39:37 +10001940 /* Hack to avoid a nasty recursion issue when Python is invoked
1941 in verbose mode: pre-import the Latin-1 and UTF-8 codecs */
1942 if ((m = PyImport_ImportModule("encodings.utf_8")) == NULL) {
1943 goto error;
1944 }
1945 Py_DECREF(m);
1946
1947 if (!(m = PyImport_ImportModule("encodings.latin_1"))) {
1948 goto error;
1949 }
1950 Py_DECREF(m);
1951
Nick Coghland6009512014-11-20 21:39:37 +10001952 if (!(iomod = PyImport_ImportModule("io"))) {
1953 goto error;
1954 }
Nick Coghland6009512014-11-20 21:39:37 +10001955
Nick Coghland6009512014-11-20 21:39:37 +10001956 /* Set sys.stdin */
1957 fd = fileno(stdin);
1958 /* Under some conditions stdin, stdout and stderr may not be connected
1959 * and fileno() may point to an invalid file descriptor. For example
1960 * GUI apps don't have valid standard streams by default.
1961 */
Victor Stinnerfbca9082018-08-30 00:50:45 +02001962 std = create_stdio(config, iomod, fd, 0, "<stdin>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001963 config->stdio_encoding,
1964 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001965 if (std == NULL)
1966 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001967 PySys_SetObject("__stdin__", std);
1968 _PySys_SetObjectId(&PyId_stdin, std);
1969 Py_DECREF(std);
1970
1971 /* Set sys.stdout */
1972 fd = fileno(stdout);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001973 std = create_stdio(config, iomod, fd, 1, "<stdout>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001974 config->stdio_encoding,
1975 config->stdio_errors);
Victor Stinner874dbe82015-09-04 17:29:57 +02001976 if (std == NULL)
1977 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001978 PySys_SetObject("__stdout__", std);
1979 _PySys_SetObjectId(&PyId_stdout, std);
1980 Py_DECREF(std);
1981
1982#if 1 /* Disable this if you have trouble debugging bootstrap stuff */
1983 /* Set sys.stderr, replaces the preliminary stderr */
1984 fd = fileno(stderr);
Victor Stinnerfbca9082018-08-30 00:50:45 +02001985 std = create_stdio(config, iomod, fd, 1, "<stderr>",
Victor Stinnerdfe0dc72018-08-29 11:47:29 +02001986 config->stdio_encoding,
Victor Stinner709d23d2019-05-02 14:56:30 -04001987 L"backslashreplace");
Victor Stinner874dbe82015-09-04 17:29:57 +02001988 if (std == NULL)
1989 goto error;
Nick Coghland6009512014-11-20 21:39:37 +10001990
1991 /* Same as hack above, pre-import stderr's codec to avoid recursion
1992 when import.c tries to write to stderr in verbose mode. */
1993 encoding_attr = PyObject_GetAttrString(std, "encoding");
1994 if (encoding_attr != NULL) {
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001995 const char *std_encoding = PyUnicode_AsUTF8(encoding_attr);
Nick Coghland6009512014-11-20 21:39:37 +10001996 if (std_encoding != NULL) {
1997 PyObject *codec_info = _PyCodec_Lookup(std_encoding);
1998 Py_XDECREF(codec_info);
1999 }
2000 Py_DECREF(encoding_attr);
2001 }
Victor Stinnerb45d2592019-06-20 00:05:23 +02002002 _PyErr_Clear(tstate); /* Not a fatal error if codec isn't available */
Nick Coghland6009512014-11-20 21:39:37 +10002003
2004 if (PySys_SetObject("__stderr__", std) < 0) {
2005 Py_DECREF(std);
2006 goto error;
2007 }
2008 if (_PySys_SetObjectId(&PyId_stderr, std) < 0) {
2009 Py_DECREF(std);
2010 goto error;
2011 }
2012 Py_DECREF(std);
2013#endif
2014
Victor Stinnera7368ac2017-11-15 18:11:45 -08002015 goto done;
Nick Coghland6009512014-11-20 21:39:37 +10002016
Victor Stinnera7368ac2017-11-15 18:11:45 -08002017error:
Victor Stinner331a6a52019-05-27 16:39:22 +02002018 res = _PyStatus_ERR("can't initialize sys standard streams");
Victor Stinnera7368ac2017-11-15 18:11:45 -08002019
2020done:
Victor Stinner124b9eb2018-08-29 01:29:06 +02002021 _Py_ClearStandardStreamEncoding();
Nick Coghland6009512014-11-20 21:39:37 +10002022 Py_XDECREF(iomod);
Victor Stinnera7368ac2017-11-15 18:11:45 -08002023 return res;
Nick Coghland6009512014-11-20 21:39:37 +10002024}
2025
2026
Victor Stinner10dc4842015-03-24 12:01:30 +01002027static void
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002028_Py_FatalError_DumpTracebacks(int fd, PyInterpreterState *interp,
2029 PyThreadState *tstate)
Victor Stinner10dc4842015-03-24 12:01:30 +01002030{
Victor Stinner10dc4842015-03-24 12:01:30 +01002031 fputc('\n', stderr);
2032 fflush(stderr);
2033
2034 /* display the current Python stack */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002035 _Py_DumpTracebackThreads(fd, interp, tstate);
Victor Stinner10dc4842015-03-24 12:01:30 +01002036}
Victor Stinner791da1c2016-03-14 16:53:12 +01002037
2038/* Print the current exception (if an exception is set) with its traceback,
2039 or display the current Python stack.
2040
2041 Don't call PyErr_PrintEx() and the except hook, because Py_FatalError() is
2042 called on catastrophic cases.
2043
2044 Return 1 if the traceback was displayed, 0 otherwise. */
2045
2046static int
2047_Py_FatalError_PrintExc(int fd)
2048{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002049 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner791da1c2016-03-14 16:53:12 +01002050 PyObject *ferr, *res;
2051 PyObject *exception, *v, *tb;
2052 int has_tb;
2053
Victor Stinnerb45d2592019-06-20 00:05:23 +02002054 _PyErr_Fetch(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002055 if (exception == NULL) {
2056 /* No current exception */
2057 return 0;
2058 }
2059
2060 ferr = _PySys_GetObjectId(&PyId_stderr);
2061 if (ferr == NULL || ferr == Py_None) {
2062 /* sys.stderr is not set yet or set to None,
2063 no need to try to display the exception */
2064 return 0;
2065 }
2066
Victor Stinnerb45d2592019-06-20 00:05:23 +02002067 _PyErr_NormalizeException(tstate, &exception, &v, &tb);
Victor Stinner791da1c2016-03-14 16:53:12 +01002068 if (tb == NULL) {
2069 tb = Py_None;
2070 Py_INCREF(tb);
2071 }
2072 PyException_SetTraceback(v, tb);
2073 if (exception == NULL) {
2074 /* PyErr_NormalizeException() failed */
2075 return 0;
2076 }
2077
2078 has_tb = (tb != Py_None);
2079 PyErr_Display(exception, v, tb);
2080 Py_XDECREF(exception);
2081 Py_XDECREF(v);
2082 Py_XDECREF(tb);
2083
2084 /* sys.stderr may be buffered: call sys.stderr.flush() */
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002085 res = _PyObject_CallMethodIdNoArgs(ferr, &PyId_flush);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002086 if (res == NULL) {
2087 _PyErr_Clear(tstate);
2088 }
2089 else {
Victor Stinner791da1c2016-03-14 16:53:12 +01002090 Py_DECREF(res);
Victor Stinnerb45d2592019-06-20 00:05:23 +02002091 }
Victor Stinner791da1c2016-03-14 16:53:12 +01002092
2093 return has_tb;
2094}
2095
Nick Coghland6009512014-11-20 21:39:37 +10002096/* Print fatal error message and abort */
2097
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002098#ifdef MS_WINDOWS
2099static void
2100fatal_output_debug(const char *msg)
2101{
2102 /* buffer of 256 bytes allocated on the stack */
2103 WCHAR buffer[256 / sizeof(WCHAR)];
2104 size_t buflen = Py_ARRAY_LENGTH(buffer) - 1;
2105 size_t msglen;
2106
2107 OutputDebugStringW(L"Fatal Python error: ");
2108
2109 msglen = strlen(msg);
2110 while (msglen) {
2111 size_t i;
2112
2113 if (buflen > msglen) {
2114 buflen = msglen;
2115 }
2116
2117 /* Convert the message to wchar_t. This uses a simple one-to-one
2118 conversion, assuming that the this error message actually uses
2119 ASCII only. If this ceases to be true, we will have to convert. */
2120 for (i=0; i < buflen; ++i) {
2121 buffer[i] = msg[i];
2122 }
2123 buffer[i] = L'\0';
2124 OutputDebugStringW(buffer);
2125
2126 msg += buflen;
2127 msglen -= buflen;
2128 }
2129 OutputDebugStringW(L"\n");
2130}
2131#endif
2132
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002133
2134static void
2135fatal_error_dump_runtime(FILE *stream, _PyRuntimeState *runtime)
2136{
2137 fprintf(stream, "Python runtime state: ");
2138 if (runtime->finalizing) {
2139 fprintf(stream, "finalizing (tstate=%p)", runtime->finalizing);
2140 }
2141 else if (runtime->initialized) {
2142 fprintf(stream, "initialized");
2143 }
2144 else if (runtime->core_initialized) {
2145 fprintf(stream, "core initialized");
2146 }
2147 else if (runtime->preinitialized) {
2148 fprintf(stream, "preinitialized");
2149 }
2150 else if (runtime->preinitializing) {
2151 fprintf(stream, "preinitializing");
2152 }
2153 else {
2154 fprintf(stream, "unknown");
2155 }
2156 fprintf(stream, "\n");
2157 fflush(stream);
2158}
2159
2160
Benjamin Petersoncef88b92017-11-25 13:02:55 -08002161static void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002162fatal_error(const char *prefix, const char *msg, int status)
Nick Coghland6009512014-11-20 21:39:37 +10002163{
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002164 FILE *stream = stderr;
2165 const int fd = fileno(stream);
Victor Stinner53345a42015-03-25 01:55:14 +01002166 static int reentrant = 0;
Victor Stinner53345a42015-03-25 01:55:14 +01002167
2168 if (reentrant) {
2169 /* Py_FatalError() caused a second fatal error.
2170 Example: flush_std_files() raises a recursion error. */
2171 goto exit;
2172 }
2173 reentrant = 1;
Nick Coghland6009512014-11-20 21:39:37 +10002174
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002175 fprintf(stream, "Fatal Python error: ");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002176 if (prefix) {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002177 fputs(prefix, stream);
2178 fputs(": ", stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002179 }
2180 if (msg) {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002181 fputs(msg, stream);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002182 }
2183 else {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002184 fprintf(stream, "<message not set>");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002185 }
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002186 fputs("\n", stream);
2187 fflush(stream); /* it helps in Windows debug build */
2188
2189 _PyRuntimeState *runtime = &_PyRuntime;
2190 fatal_error_dump_runtime(stream, runtime);
2191
2192 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
2193 PyInterpreterState *interp = NULL;
2194 if (tstate != NULL) {
2195 interp = tstate->interp;
2196 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002197
Victor Stinner3a228ab2018-11-01 00:26:41 +01002198 /* Check if the current thread has a Python thread state
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002199 and holds the GIL.
Victor Stinner3a228ab2018-11-01 00:26:41 +01002200
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002201 tss_tstate is NULL if Py_FatalError() is called from a C thread which
2202 has no Python thread state.
2203
2204 tss_tstate != tstate if the current Python thread does not hold the GIL.
2205 */
2206 PyThreadState *tss_tstate = PyGILState_GetThisThreadState();
2207 int has_tstate_and_gil = (tss_tstate != NULL && tss_tstate == tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002208 if (has_tstate_and_gil) {
2209 /* If an exception is set, print the exception with its traceback */
2210 if (!_Py_FatalError_PrintExc(fd)) {
2211 /* No exception is set, or an exception is set without traceback */
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002212 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner3a228ab2018-11-01 00:26:41 +01002213 }
2214 }
2215 else {
Victor Stinner1ce16fb2019-09-18 01:35:33 +02002216 _Py_FatalError_DumpTracebacks(fd, interp, tss_tstate);
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002217 }
Victor Stinner10dc4842015-03-24 12:01:30 +01002218
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002219 /* The main purpose of faulthandler is to display the traceback.
2220 This function already did its best to display a traceback.
2221 Disable faulthandler to prevent writing a second traceback
2222 on abort(). */
Victor Stinner2025d782016-03-16 23:19:15 +01002223 _PyFaulthandler_Fini();
2224
Victor Stinner791da1c2016-03-14 16:53:12 +01002225 /* Check if the current Python thread hold the GIL */
Victor Stinner3a228ab2018-11-01 00:26:41 +01002226 if (has_tstate_and_gil) {
Victor Stinner791da1c2016-03-14 16:53:12 +01002227 /* Flush sys.stdout and sys.stderr */
2228 flush_std_files();
2229 }
Victor Stinnere0deff32015-03-24 13:46:18 +01002230
Nick Coghland6009512014-11-20 21:39:37 +10002231#ifdef MS_WINDOWS
Victor Stinner8d5a3aa2017-10-04 09:50:12 -07002232 fatal_output_debug(msg);
Victor Stinner53345a42015-03-25 01:55:14 +01002233#endif /* MS_WINDOWS */
2234
2235exit:
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002236 if (status < 0) {
Victor Stinner53345a42015-03-25 01:55:14 +01002237#if defined(MS_WINDOWS) && defined(_DEBUG)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002238 DebugBreak();
Nick Coghland6009512014-11-20 21:39:37 +10002239#endif
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002240 abort();
2241 }
2242 else {
2243 exit(status);
2244 }
2245}
2246
Victor Stinner19760862017-12-20 01:41:59 +01002247void _Py_NO_RETURN
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002248Py_FatalError(const char *msg)
2249{
2250 fatal_error(NULL, msg, -1);
2251}
2252
Victor Stinner19760862017-12-20 01:41:59 +01002253void _Py_NO_RETURN
Victor Stinner331a6a52019-05-27 16:39:22 +02002254Py_ExitStatusException(PyStatus status)
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002255{
Victor Stinner331a6a52019-05-27 16:39:22 +02002256 if (_PyStatus_IS_EXIT(status)) {
2257 exit(status.exitcode);
Victor Stinnerdbacfc22019-05-16 16:39:26 +02002258 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002259 else if (_PyStatus_IS_ERROR(status)) {
2260 fatal_error(status.func, status.err_msg, 1);
Victor Stinnerdfe88472019-03-01 12:14:41 +01002261 }
2262 else {
Victor Stinner331a6a52019-05-27 16:39:22 +02002263 Py_FatalError("Py_ExitStatusException() must not be called on success");
Victor Stinnerdfe88472019-03-01 12:14:41 +01002264 }
Nick Coghland6009512014-11-20 21:39:37 +10002265}
2266
2267/* Clean up and exit */
2268
Victor Stinnerd7292b52016-06-17 12:29:00 +02002269# include "pythread.h"
Nick Coghland6009512014-11-20 21:39:37 +10002270
Nick Coghland6009512014-11-20 21:39:37 +10002271/* For the atexit module. */
Marcel Plch776407f2017-12-20 11:17:58 +01002272void _Py_PyAtExit(void (*func)(PyObject *), PyObject *module)
Nick Coghland6009512014-11-20 21:39:37 +10002273{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002274 PyInterpreterState *is = _PyInterpreterState_GET_UNSAFE();
Marcel Plch776407f2017-12-20 11:17:58 +01002275
Antoine Pitroufc5db952017-12-13 02:29:07 +01002276 /* Guard against API misuse (see bpo-17852) */
Marcel Plch776407f2017-12-20 11:17:58 +01002277 assert(is->pyexitfunc == NULL || is->pyexitfunc == func);
2278
2279 is->pyexitfunc = func;
2280 is->pyexitmodule = module;
Nick Coghland6009512014-11-20 21:39:37 +10002281}
2282
2283static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002284call_py_exitfuncs(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002285{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002286 PyInterpreterState *interp = tstate->interp;
2287 if (interp->pyexitfunc == NULL)
Nick Coghland6009512014-11-20 21:39:37 +10002288 return;
2289
Victor Stinnerb45d2592019-06-20 00:05:23 +02002290 (*interp->pyexitfunc)(interp->pyexitmodule);
2291 _PyErr_Clear(tstate);
Nick Coghland6009512014-11-20 21:39:37 +10002292}
2293
2294/* Wait until threading._shutdown completes, provided
2295 the threading module was imported in the first place.
2296 The shutdown routine will wait until all non-daemon
2297 "threading" threads have completed. */
2298static void
Victor Stinnerb45d2592019-06-20 00:05:23 +02002299wait_for_thread_shutdown(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002300{
Nick Coghland6009512014-11-20 21:39:37 +10002301 _Py_IDENTIFIER(_shutdown);
2302 PyObject *result;
Eric Snow3f9eee62017-09-15 16:35:20 -06002303 PyObject *threading = _PyImport_GetModuleId(&PyId_threading);
Nick Coghland6009512014-11-20 21:39:37 +10002304 if (threading == NULL) {
Victor Stinnerb45d2592019-06-20 00:05:23 +02002305 if (_PyErr_Occurred(tstate)) {
Stefan Krah027b09c2019-03-25 21:50:58 +01002306 PyErr_WriteUnraisable(NULL);
2307 }
2308 /* else: threading not imported */
Nick Coghland6009512014-11-20 21:39:37 +10002309 return;
2310 }
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02002311 result = _PyObject_CallMethodIdNoArgs(threading, &PyId__shutdown);
Nick Coghland6009512014-11-20 21:39:37 +10002312 if (result == NULL) {
2313 PyErr_WriteUnraisable(threading);
2314 }
2315 else {
2316 Py_DECREF(result);
2317 }
2318 Py_DECREF(threading);
Nick Coghland6009512014-11-20 21:39:37 +10002319}
2320
2321#define NEXITFUNCS 32
Nick Coghland6009512014-11-20 21:39:37 +10002322int Py_AtExit(void (*func)(void))
2323{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002324 if (_PyRuntime.nexitfuncs >= NEXITFUNCS)
Nick Coghland6009512014-11-20 21:39:37 +10002325 return -1;
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002326 _PyRuntime.exitfuncs[_PyRuntime.nexitfuncs++] = func;
Nick Coghland6009512014-11-20 21:39:37 +10002327 return 0;
2328}
2329
2330static void
Victor Stinner8e91c242019-04-24 17:24:01 +02002331call_ll_exitfuncs(_PyRuntimeState *runtime)
Nick Coghland6009512014-11-20 21:39:37 +10002332{
Victor Stinner8e91c242019-04-24 17:24:01 +02002333 while (runtime->nexitfuncs > 0) {
Victor Stinner87d23a02019-04-26 05:49:26 +02002334 /* pop last function from the list */
2335 runtime->nexitfuncs--;
2336 void (*exitfunc)(void) = runtime->exitfuncs[runtime->nexitfuncs];
2337 runtime->exitfuncs[runtime->nexitfuncs] = NULL;
2338
2339 exitfunc();
Victor Stinner8e91c242019-04-24 17:24:01 +02002340 }
Nick Coghland6009512014-11-20 21:39:37 +10002341
2342 fflush(stdout);
2343 fflush(stderr);
2344}
2345
Victor Stinnercfc88312018-08-01 16:41:25 +02002346void _Py_NO_RETURN
Nick Coghland6009512014-11-20 21:39:37 +10002347Py_Exit(int sts)
2348{
Martin Panterb4ce1fc2015-11-30 03:18:29 +00002349 if (Py_FinalizeEx() < 0) {
2350 sts = 120;
2351 }
Nick Coghland6009512014-11-20 21:39:37 +10002352
2353 exit(sts);
2354}
2355
Victor Stinner331a6a52019-05-27 16:39:22 +02002356static PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02002357init_signals(PyThreadState *tstate)
Nick Coghland6009512014-11-20 21:39:37 +10002358{
2359#ifdef SIGPIPE
2360 PyOS_setsig(SIGPIPE, SIG_IGN);
2361#endif
2362#ifdef SIGXFZ
2363 PyOS_setsig(SIGXFZ, SIG_IGN);
2364#endif
2365#ifdef SIGXFSZ
2366 PyOS_setsig(SIGXFSZ, SIG_IGN);
2367#endif
2368 PyOS_InitInterrupts(); /* May imply initsignal() */
Victor Stinnerb45d2592019-06-20 00:05:23 +02002369 if (_PyErr_Occurred(tstate)) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002370 return _PyStatus_ERR("can't import signal");
Nick Coghland6009512014-11-20 21:39:37 +10002371 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002372 return _PyStatus_OK();
Nick Coghland6009512014-11-20 21:39:37 +10002373}
2374
2375
2376/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL.
2377 *
2378 * All of the code in this function must only use async-signal-safe functions,
2379 * listed at `man 7 signal` or
2380 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2381 */
2382void
2383_Py_RestoreSignals(void)
2384{
2385#ifdef SIGPIPE
2386 PyOS_setsig(SIGPIPE, SIG_DFL);
2387#endif
2388#ifdef SIGXFZ
2389 PyOS_setsig(SIGXFZ, SIG_DFL);
2390#endif
2391#ifdef SIGXFSZ
2392 PyOS_setsig(SIGXFSZ, SIG_DFL);
2393#endif
2394}
2395
2396
2397/*
2398 * The file descriptor fd is considered ``interactive'' if either
2399 * a) isatty(fd) is TRUE, or
2400 * b) the -i flag was given, and the filename associated with
2401 * the descriptor is NULL or "<stdin>" or "???".
2402 */
2403int
2404Py_FdIsInteractive(FILE *fp, const char *filename)
2405{
2406 if (isatty((int)fileno(fp)))
2407 return 1;
2408 if (!Py_InteractiveFlag)
2409 return 0;
2410 return (filename == NULL) ||
2411 (strcmp(filename, "<stdin>") == 0) ||
2412 (strcmp(filename, "???") == 0);
2413}
2414
2415
Nick Coghland6009512014-11-20 21:39:37 +10002416/* Wrappers around sigaction() or signal(). */
2417
2418PyOS_sighandler_t
2419PyOS_getsig(int sig)
2420{
2421#ifdef HAVE_SIGACTION
2422 struct sigaction context;
2423 if (sigaction(sig, NULL, &context) == -1)
2424 return SIG_ERR;
2425 return context.sa_handler;
2426#else
2427 PyOS_sighandler_t handler;
2428/* Special signal handling for the secure CRT in Visual Studio 2005 */
2429#if defined(_MSC_VER) && _MSC_VER >= 1400
2430 switch (sig) {
2431 /* Only these signals are valid */
2432 case SIGINT:
2433 case SIGILL:
2434 case SIGFPE:
2435 case SIGSEGV:
2436 case SIGTERM:
2437 case SIGBREAK:
2438 case SIGABRT:
2439 break;
2440 /* Don't call signal() with other values or it will assert */
2441 default:
2442 return SIG_ERR;
2443 }
2444#endif /* _MSC_VER && _MSC_VER >= 1400 */
2445 handler = signal(sig, SIG_IGN);
2446 if (handler != SIG_ERR)
2447 signal(sig, handler);
2448 return handler;
2449#endif
2450}
2451
2452/*
2453 * All of the code in this function must only use async-signal-safe functions,
2454 * listed at `man 7 signal` or
2455 * http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html.
2456 */
2457PyOS_sighandler_t
2458PyOS_setsig(int sig, PyOS_sighandler_t handler)
2459{
2460#ifdef HAVE_SIGACTION
2461 /* Some code in Modules/signalmodule.c depends on sigaction() being
2462 * used here if HAVE_SIGACTION is defined. Fix that if this code
2463 * changes to invalidate that assumption.
2464 */
2465 struct sigaction context, ocontext;
2466 context.sa_handler = handler;
2467 sigemptyset(&context.sa_mask);
2468 context.sa_flags = 0;
2469 if (sigaction(sig, &context, &ocontext) == -1)
2470 return SIG_ERR;
2471 return ocontext.sa_handler;
2472#else
2473 PyOS_sighandler_t oldhandler;
2474 oldhandler = signal(sig, handler);
2475#ifdef HAVE_SIGINTERRUPT
2476 siginterrupt(sig, 1);
2477#endif
2478 return oldhandler;
2479#endif
2480}
2481
2482#ifdef __cplusplus
2483}
2484#endif