#include "Python.h"

#include "pycore_fileutils.h"     // _Py_HasFileSystemDefaultEncodeErrors

#include "pycore_getopt.h"        // _PyOS_GetOpt()

#include "pycore_initconfig.h"    // _PyStatus_OK()

#include "pycore_interp.h"        // _PyInterpreterState.runtime

#include "pycore_long.h"          // _PY_LONG_MAX_STR_DIGITS_THRESHOLD

#include "pycore_pathconfig.h"    // _Py_path_config

#include "pycore_pyerrors.h"      // _PyErr_GetRaisedException()

#include "pycore_pylifecycle.h"   // _Py_PreInitializeFromConfig()

#include "pycore_pymem.h"         // _PyMem_DefaultRawMalloc()

#include "pycore_pyhash.h"        // _Py_HashSecret

#include "pycore_pystate.h"       // _PyThreadState_GET()

#include "pycore_pystats.h"       // _Py_StatsOn()

#include "pycore_sysmodule.h"     // _PySys_SetIntMaxStrDigits()

#include "osdefs.h"               // DELIM

#include <locale.h>               // setlocale()

#include <stdlib.h>               // getenv()

#if defined(MS_WINDOWS) || defined(__CYGWIN__)

#  ifdef HAVE_IO_H

#    include <io.h>

#  endif

#  ifdef HAVE_FCNTL_H

#    include <fcntl.h>            // O_BINARY

#  endif

#endif

#ifdef __APPLE__

/* Enable system log by default on non-macOS Apple platforms */

#  if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE

#define USE_SYSTEM_LOGGER_DEFAULT 1;

#  else

#define USE_SYSTEM_LOGGER_DEFAULT 0;

#  endif

#endif

#include "config_common.h"

/* --- PyConfig setters ------------------------------------------- */

typedef PyObject* (*config_sys_flag_setter) (int value);

static PyObject*

config_sys_flag_long(int value)

{

    return PyLong_FromLong(value);

}

static PyObject*

config_sys_flag_not(int value)

{

    value = (!value);

    return config_sys_flag_long(value);

}

/* --- PyConfig spec ---------------------------------------------- */

typedef enum {

    PyConfig_MEMBER_INT = 0,

    PyConfig_MEMBER_UINT = 1,

    PyConfig_MEMBER_ULONG = 2,

    PyConfig_MEMBER_BOOL = 3,

    PyConfig_MEMBER_WSTR = 10,

    PyConfig_MEMBER_WSTR_OPT = 11,

    PyConfig_MEMBER_WSTR_LIST = 12,

} PyConfigMemberType;

typedef enum {

    // Option which cannot be get or set by PyConfig_Get() and PyConfig_Set()

    PyConfig_MEMBER_INIT_ONLY = 0,

    // Option which cannot be set by PyConfig_Set()

    PyConfig_MEMBER_READ_ONLY = 1,

    // Public option: can be get and set by PyConfig_Get() and PyConfig_Set()

    PyConfig_MEMBER_PUBLIC = 2,

} PyConfigMemberVisibility;

typedef struct {

    const char *attr;

    int flag_index;

    config_sys_flag_setter flag_setter;

} PyConfigSysSpec;

typedef struct {

    int *ptr;

    int not;

} PyConfigGlobalVar;

typedef struct {

    const char *name;

    size_t offset;

    PyConfigMemberType type;

    PyConfigMemberVisibility visibility;

    PyConfigSysSpec sys;

} PyConfigSpec;

#define SPEC(MEMBER, TYPE, VISIBILITY, sys) \

    {#MEMBER, offsetof(PyConfig, MEMBER), \

     PyConfig_MEMBER_##TYPE, PyConfig_MEMBER_##VISIBILITY, sys}

#define SYS_ATTR(name) {name, -1, NULL}

#define SYS_FLAG_SETTER(index, setter) {NULL, index, setter}

#define SYS_FLAG(index) SYS_FLAG_SETTER(index, NULL)

#define NO_SYS SYS_ATTR(NULL)

// Update _test_embed_set_config when adding new members

static const PyConfigSpec PYCONFIG_SPEC[] = {

    // --- Public options -----------

    SPEC(argv, WSTR_LIST, PUBLIC, SYS_ATTR("argv")),

    SPEC(base_exec_prefix, WSTR_OPT, PUBLIC, SYS_ATTR("base_exec_prefix")),

    SPEC(base_executable, WSTR_OPT, PUBLIC, SYS_ATTR("_base_executable")),

    SPEC(base_prefix, WSTR_OPT, PUBLIC, SYS_ATTR("base_prefix")),

    SPEC(bytes_warning, UINT, PUBLIC, SYS_FLAG(9)),

    SPEC(cpu_count, INT, PUBLIC, NO_SYS),

    SPEC(lazy_imports, INT, PUBLIC, NO_SYS),

    SPEC(exec_prefix, WSTR_OPT, PUBLIC, SYS_ATTR("exec_prefix")),

    SPEC(executable, WSTR_OPT, PUBLIC, SYS_ATTR("executable")),

    SPEC(inspect, BOOL, PUBLIC, SYS_FLAG(1)),

    SPEC(int_max_str_digits, UINT, PUBLIC, NO_SYS),

    SPEC(interactive, BOOL, PUBLIC, SYS_FLAG(2)),

    SPEC(module_search_paths, WSTR_LIST, PUBLIC, SYS_ATTR("path")),

    SPEC(optimization_level, UINT, PUBLIC, SYS_FLAG(3)),

    SPEC(parser_debug, BOOL, PUBLIC, SYS_FLAG(0)),

    SPEC(platlibdir, WSTR, PUBLIC, SYS_ATTR("platlibdir")),

    SPEC(prefix, WSTR_OPT, PUBLIC, SYS_ATTR("prefix")),

    SPEC(pycache_prefix, WSTR_OPT, PUBLIC, SYS_ATTR("pycache_prefix")),

    SPEC(quiet, BOOL, PUBLIC, SYS_FLAG(10)),

    SPEC(stdlib_dir, WSTR_OPT, PUBLIC, SYS_ATTR("_stdlib_dir")),

    SPEC(use_environment, BOOL, PUBLIC,

         SYS_FLAG_SETTER(7, config_sys_flag_not)),

    SPEC(verbose, UINT, PUBLIC, SYS_FLAG(8)),

    SPEC(warnoptions, WSTR_LIST, PUBLIC, SYS_ATTR("warnoptions")),

    SPEC(write_bytecode, BOOL, PUBLIC, SYS_FLAG_SETTER(4, config_sys_flag_not)),

    SPEC(xoptions, WSTR_LIST, PUBLIC, SYS_ATTR("_xoptions")),

    // --- Read-only options -----------

#ifdef Py_STATS

    SPEC(_pystats, BOOL, READ_ONLY, NO_SYS),

#endif

    SPEC(buffered_stdio, BOOL, READ_ONLY, NO_SYS),

    SPEC(check_hash_pycs_mode, WSTR, READ_ONLY, NO_SYS),

    SPEC(code_debug_ranges, BOOL, READ_ONLY, NO_SYS),

    SPEC(configure_c_stdio, BOOL, READ_ONLY, NO_SYS),

    SPEC(dev_mode, BOOL, READ_ONLY, NO_SYS),  // sys.flags.dev_mode

    SPEC(dump_refs, BOOL, READ_ONLY, NO_SYS),

    SPEC(dump_refs_file, WSTR_OPT, READ_ONLY, NO_SYS),

#ifdef Py_GIL_DISABLED

    SPEC(enable_gil, INT, READ_ONLY, NO_SYS),

    SPEC(tlbc_enabled, INT, READ_ONLY, NO_SYS),

#endif

    SPEC(faulthandler, BOOL, READ_ONLY, NO_SYS),

    SPEC(filesystem_encoding, WSTR, READ_ONLY, NO_SYS),

    SPEC(filesystem_errors, WSTR, READ_ONLY, NO_SYS),

    SPEC(hash_seed, ULONG, READ_ONLY, NO_SYS),

    SPEC(home, WSTR_OPT, READ_ONLY, NO_SYS),

    SPEC(thread_inherit_context, INT, READ_ONLY, NO_SYS),

    SPEC(context_aware_warnings, INT, READ_ONLY, NO_SYS),

    SPEC(import_time, UINT, READ_ONLY, NO_SYS),

    SPEC(install_signal_handlers, BOOL, READ_ONLY, NO_SYS),

    SPEC(isolated, BOOL, READ_ONLY, NO_SYS),  // sys.flags.isolated

#ifdef MS_WINDOWS

    SPEC(legacy_windows_stdio, BOOL, READ_ONLY, NO_SYS),

#endif

    SPEC(malloc_stats, BOOL, READ_ONLY, NO_SYS),

    SPEC(pymalloc_hugepages, BOOL, READ_ONLY, NO_SYS),

    SPEC(orig_argv, WSTR_LIST, READ_ONLY, SYS_ATTR("orig_argv")),

    SPEC(parse_argv, BOOL, READ_ONLY, NO_SYS),

    SPEC(pathconfig_warnings, BOOL, READ_ONLY, NO_SYS),

    SPEC(perf_profiling, UINT, READ_ONLY, NO_SYS),

    SPEC(remote_debug, BOOL, READ_ONLY, NO_SYS),

    SPEC(program_name, WSTR, READ_ONLY, NO_SYS),

    SPEC(run_command, WSTR_OPT, READ_ONLY, NO_SYS),

    SPEC(run_filename, WSTR_OPT, READ_ONLY, NO_SYS),

    SPEC(run_module, WSTR_OPT, READ_ONLY, NO_SYS),

#ifdef Py_DEBUG

    SPEC(run_presite, WSTR_OPT, READ_ONLY, NO_SYS),

#endif

    SPEC(safe_path, BOOL, READ_ONLY, NO_SYS),

    SPEC(show_ref_count, BOOL, READ_ONLY, NO_SYS),

    SPEC(site_import, BOOL, READ_ONLY, NO_SYS),  // sys.flags.no_site

    SPEC(skip_source_first_line, BOOL, READ_ONLY, NO_SYS),

    SPEC(stdio_encoding, WSTR_OPT, READ_ONLY, NO_SYS),

    SPEC(stdio_errors, WSTR, READ_ONLY, NO_SYS),

    SPEC(tracemalloc, UINT, READ_ONLY, NO_SYS),

    SPEC(use_frozen_modules, BOOL, READ_ONLY, NO_SYS),

    SPEC(use_hash_seed, BOOL, READ_ONLY, NO_SYS),

#ifdef __APPLE__

    SPEC(use_system_logger, BOOL, READ_ONLY, NO_SYS),

#endif

    SPEC(user_site_directory, BOOL, READ_ONLY, NO_SYS),  // sys.flags.no_user_site

    SPEC(warn_default_encoding, BOOL, READ_ONLY, NO_SYS),

    // --- Init-only options -----------

    SPEC(_config_init, UINT, INIT_ONLY, NO_SYS),

    SPEC(_init_main, BOOL, INIT_ONLY, NO_SYS),

    SPEC(_install_importlib, BOOL, INIT_ONLY, NO_SYS),

    SPEC(_is_python_build, BOOL, INIT_ONLY, NO_SYS),

    SPEC(module_search_paths_set, BOOL, INIT_ONLY, NO_SYS),

    SPEC(pythonpath_env, WSTR_OPT, INIT_ONLY, NO_SYS),

    SPEC(sys_path_0, WSTR_OPT, INIT_ONLY, NO_SYS),

    SPEC(_deferred_cmdline_option, INT, INIT_ONLY, NO_SYS),

    // Array terminator

    {NULL, 0, 0, 0, NO_SYS},

};

#undef SPEC

#define SPEC(MEMBER, TYPE, VISIBILITY) \

    {#MEMBER, offsetof(PyPreConfig, MEMBER), PyConfig_MEMBER_##TYPE, \

     PyConfig_MEMBER_##VISIBILITY, NO_SYS}

static const PyConfigSpec PYPRECONFIG_SPEC[] = {

    // --- Read-only options -----------

    SPEC(allocator, INT, READ_ONLY),

    SPEC(coerce_c_locale, BOOL, READ_ONLY),

    SPEC(coerce_c_locale_warn, BOOL, READ_ONLY),

    SPEC(configure_locale, BOOL, READ_ONLY),

#ifdef MS_WINDOWS

    SPEC(legacy_windows_fs_encoding, BOOL, READ_ONLY),

#endif

    SPEC(utf8_mode, BOOL, READ_ONLY),

    // --- Init-only options -----------

    // Members already present in PYCONFIG_SPEC

    SPEC(_config_init, INT, INIT_ONLY),

    SPEC(dev_mode, BOOL, INIT_ONLY),

    SPEC(isolated, BOOL, INIT_ONLY),

    SPEC(parse_argv, BOOL, INIT_ONLY),

    SPEC(use_environment, BOOL, INIT_ONLY),

    // Array terminator

    {NULL, 0, 0, 0, NO_SYS},

};

#undef SPEC

#undef SYS_ATTR

#undef SYS_FLAG_SETTER

#undef SYS_FLAG

#undef NO_SYS

// Forward declarations

static PyObject* config_get(const PyConfig *config, const PyConfigSpec *spec,

                            int use_sys);

static void initconfig_free_wstr(wchar_t *member);

static void initconfig_free_wstr_list(PyWideStringList *list);

static void initconfig_free_config(const PyConfig *config);

/* --- Command line options --------------------------------------- */

/*

 * Help text markup (matching Lib/_colorize.py Argparse theme).

 *

 * Color spans, #X{...}  where "}" resets to default color:

 *   #b{...}  label              bold yellow

 *   #B{...}  summary label      yellow

 *   #E{...}  env var (primary)  bold cyan

 *   #e{...}  env var reference  cyan

 *   #h{...}  heading            bold blue

 *   #L{...}  long option        bold cyan

 *   #s{...}  short option       bold green

 *   #S{...}  summary short opt  green

 *

 * Runtime substitutions (no "{" follows):

 *   #P  program name (bold magenta)

 *   #D  path separator (DELIM)

 *   #H  PYTHONHOMEHELP default search path

 *

 * fprint_help() walks the string, expanding color codes only when colorize=1

 * and substituting runtime values regardless.

 */

#if defined(MS_WINDOWS)

#  define PYTHONHOMEHELP "<prefix>\\python{major}{minor}"

#else

#  define PYTHONHOMEHELP "<prefix>/lib/pythonX.X"

#endif

/* Determine if we can emit ANSI color codes on the given stream.

 * Logic mirrors Lib/_colorize.py:can_colorize(). */

static int

_Py_can_colorize(FILE *f)

{

    const char *env;

    env = Py_GETENV("PYTHON_COLORS");

    if (env) {

        if (strcmp(env, "0") == 0) {

            return 0;

        }

        if (strcmp(env, "1") == 0) {

            return 1;

        }

    }

    if (getenv("NO_COLOR")) {

        return 0;

    }

    if (getenv("FORCE_COLOR")) {

        return 1;

    }

    env = getenv("TERM");

    if (env && strcmp(env, "dumb") == 0) {

        return 0;

    }

#if defined(MS_WINDOWS) && defined(HAVE_WINDOWS_CONSOLE_IO)

    {

        DWORD mode = 0;

        DWORD nStdHandle = (f == stderr) ? STD_ERROR_HANDLE

                                         : STD_OUTPUT_HANDLE;

        HANDLE handle = GetStdHandle(nStdHandle);

        if (!GetConsoleMode(handle, &mode)

            || !(mode & ENABLE_VIRTUAL_TERMINAL_PROCESSING))

        {

            return 0;

        }

    }

#endif

    return isatty(fileno(f));

}

/* Walk help text, expanding markup:

 *   #X{...}  color span (only emitted when colorize=1; '}' resets).

 *   #X       runtime substitution (program name, DELIM, PYTHONHOMEHELP).

 * See the markup table above the macro/comment block. */

static void

fprint_help(FILE *f, const char *text, int colorize, const wchar_t *program)

{

    for (const char *p = text; *p; ) {

        if (*p == '#' && p[1]) {

            char code = p[1];

            if (p[2] == '{') {

                /* Color span open */

                const char *seq = NULL;

                switch (code) {

                case 'h': seq = "\x1b[1;34m"; break;  // heading

                case 'E': seq = "\x1b[1;36m"; break;  // env var primary

                case 'e': seq = "\x1b[36m";   break;  // env var reference

                case 'L': seq = "\x1b[1;36m"; break;  // long option

                case 'b': seq = "\x1b[1;33m"; break;  // label

                case 'B': seq = "\x1b[33m";   break;  // summary label

                case 's': seq = "\x1b[1;32m"; break;  // short option

                case 'S': seq = "\x1b[32m";   break;  // summary short option

                }

                if (colorize && seq) fputs(seq, f);

                p += 3;  // skip "#X{"

                continue;

            }

            /* Runtime substitution */

            switch (code) {

            case 'P':  // program name with bold magenta

                if (colorize) fputs("\x1b[1;35m", f);

                if (program) fprintf(f, "%ls", program);

                if (colorize) fputs("\x1b[0m", f);

                break;

            case 'D':

                fputc((char)DELIM, f);

                break;

            case 'H':

                fputs(PYTHONHOMEHELP, f);

                break;

            default:  // unknown: emit literally

                fputc('#', f);

                fputc(code, f);

                break;

            }

            p += 2;  // skip "#X"

            continue;

        }

        if (*p == '}') {

            if (colorize) fputs("\x1b[0m", f);

            p++;

            continue;

        }

        fputc(*p++, f);

    }

}

/* Short usage message */

static const char usage_line[] =

"#h{usage:} #P [#S{option}] #S{...} "

"[#S{-c} #B{cmd} | #S{-m} #B{mod} | #S{file} | #S{-}] "

"[#S{arg}] #S{...}\n"

;

/* Long help message */

/* Lines sorted by option name; keep in sync with usage_envvars* below */

static const char usage_help[] =

"#h{Options (and corresponding environment variables):}\n"

"#s{-b}     : issue warnings about converting bytes/bytearray to str and comparing\n"

"         bytes/bytearray with str or bytes with int. (#S{-bb}: issue errors)\n"

"         deprecated since 3.15 and will become no-op in 3.17.\n"

"#s{-B}     : don't write .pyc files on import; also #e{PYTHONDONTWRITEBYTECODE}#B{=x}\n"

"#s{-c} #b{cmd} : program passed in as string (terminates option list)\n"

"#s{-d}     : turn on parser debugging output (for experts only, only works on\n"

"         debug builds); also #e{PYTHONDEBUG}#B{=x}\n"

"#s{-E}     : ignore #e{PYTHON*} environment variables (such as #e{PYTHONPATH})\n"

"#s{-h}     : print this help message and exit (also #S{-?} or #e{--help})\n"

"#s{-i}     : inspect interactively after running script; forces a prompt even\n"

"         if stdin does not appear to be a terminal; also #e{PYTHONINSPECT}#B{=x}\n"

"#s{-I}     : isolate Python from the user's environment (implies #S{-E}, #S{-P} and #S{-s})\n"

"#s{-m} #b{mod} : run library module as a script (terminates option list)\n"

"#s{-O}     : remove assert and __debug__-dependent statements; add .opt-1 before\n"

"         .pyc extension; also #e{PYTHONOPTIMIZE}#B{=x}\n"

"#s{-OO}    : do #S{-O} changes and also discard docstrings; add .opt-2 before\n"

"         .pyc extension\n"

"#s{-P}     : don't prepend a potentially unsafe path to sys.path; also\n"

"         #e{PYTHONSAFEPATH}\n"

"#s{-q}     : don't print version and copyright messages on interactive startup\n"

"#s{-s}     : don't add user site directory to sys.path; also #e{PYTHONNOUSERSITE}#B{=x}\n"

"#s{-S}     : don't imply 'import site' on initialization\n"

"#s{-u}     : force the stdout and stderr streams to be unbuffered;\n"

"         this option has no effect on stdin; also #e{PYTHONUNBUFFERED}#B{=x}\n"

"#s{-v}     : verbose (trace import statements); also #e{PYTHONVERBOSE}#B{=x}\n"

"         can be supplied multiple times to increase verbosity\n"

"#s{-V}     : print the Python version number and exit (also #e{--version})\n"

"         when given twice, print more information about the build\n"

"#s{-W} #b{arg} : warning control; #B{arg} is action:message:category:module:lineno\n"

"         also #e{PYTHONWARNINGS}#B{=arg}\n"

"#s{-x}     : skip first line of source, allowing use of non-Unix forms of #!cmd\n"

"#s{-X} #b{opt} : set implementation-specific option\n"

"#L{--check-hash-based-pycs} #b{always|default|never}:\n"

"         control how Python invalidates hash-based .pyc files\n"

"#L{--help-env}: print help about Python environment variables and exit\n"

"#L{--help-xoptions}: print help about implementation-specific #S{-X} options and exit\n"

"#L{--help-all}: print complete help information and exit\n"

"\n"

"#h{Arguments:}\n"

"#s{file}   : program read from script file\n"

"#s{-}      : program read from stdin (default; interactive mode if a tty)\n"

"#s{arg} #b{...}: arguments passed to program in sys.argv[1:]\n"

;

static const char usage_xoptions[] =

"#h{The following implementation-specific options are available:}\n"

"#s{-X} #L{context_aware_warnings}#b{=[0|1]}: if true (#B{1}) then the warnings module will\n"

"         use a context variables; if false (#B{0}) then the warnings module will\n"

"         use module globals, which is not concurrent-safe; set to true for\n"

"         free-threaded builds and false otherwise; also\n"

"         #e{PYTHON_CONTEXT_AWARE_WARNINGS}\n"

"#s{-X} #L{cpu_count}#b{=N}: override the return value of os.cpu_count();\n"

"         #S{-X} #e{cpu_count}#B{=default} cancels overriding; also #e{PYTHON_CPU_COUNT}\n"

"#s{-X} #L{dev} : enable Python Development Mode; also #e{PYTHONDEVMODE}\n"

"#s{-X} #L{disable-remote-debug}: disable remote debugging; also #e{PYTHON_DISABLE_REMOTE_DEBUG}\n"

"#s{-X} #L{faulthandler}: dump the Python traceback on fatal errors;\n"

"         also #e{PYTHONFAULTHANDLER}\n"

"#s{-X} #L{frozen_modules}#b{=[on|off]}: whether to use frozen modules; the default is \"#B{on}\"\n"

"         for installed Python and \"#B{off}\" for a local build;\n"

"         also #e{PYTHON_FROZEN_MODULES}\n"

#ifdef Py_GIL_DISABLED

"#s{-X} #L{gil}#b{=[0|1]}: enable (#B{1}) or disable (#B{0}) the GIL; also #e{PYTHON_GIL}\n"

#endif

"#s{-X} #L{importtime}#b{[=2]}: show how long each import takes; use #S{-X} #e{importtime}#B{=2} to\n"

"         log imports of already-loaded modules; also #e{PYTHONPROFILEIMPORTTIME}\n"

"#s{-X} #L{int_max_str_digits}#b{=N}: limit the size of int<->str conversions;\n"

"         0 disables the limit; also #e{PYTHONINTMAXSTRDIGITS}\n"

"#s{-X} #L{lazy_imports}#b{=[all|normal]}: control global lazy imports;\n"

"         default is #B{normal}; also #e{PYTHON_LAZY_IMPORTS}\n"

"#s{-X} #L{no_debug_ranges}: don't include extra location information in code objects;\n"

"         also #e{PYTHONNODEBUGRANGES}\n"

"#s{-X} #L{pathconfig_warnings}#b{=[0|1]}: if true (#B{1}) then path configuration is allowed\n"

"         to log warnings into stderr; if false (#B{0}) suppress these warnings;\n"

"         set to true by default; also #e{PYTHON_PATHCONFIG_WARNINGS}\n"

"#s{-X} #L{perf}: support the Linux \"perf\" profiler; also #e{PYTHONPERFSUPPORT}#B{=1}\n"

"#s{-X} #L{perf_jit}: support the Linux \"perf\" profiler with DWARF support;\n"

"         also #e{PYTHON_PERF_JIT_SUPPORT}#B{=1}\n"

#ifdef Py_DEBUG

"#s{-X} #L{presite}#b{=MOD}: import this module before site; also #e{PYTHON_PRESITE}\n"

#endif

"#s{-X} #L{pycache_prefix}#b{=PATH}: write .pyc files to a parallel tree instead of to the\n"

"         code tree; also #e{PYTHONPYCACHEPREFIX}\n"

#ifdef Py_STATS

"#s{-X} #L{pystats}: enable pystats collection at startup; also #e{PYTHONSTATS}\n"

#endif

"#s{-X} #L{showrefcount}: output the total reference count and number of used\n"

"         memory blocks when the program finishes or after each statement in\n"

"         the interactive interpreter; only works on debug builds\n"

"#s{-X} #L{thread_inherit_context}#b{=[0|1]}: enable (#B{1}) or disable (#B{0}) threads inheriting\n"

"         context vars by default; enabled by default in the free-threaded\n"

"         build and disabled otherwise; also #e{PYTHON_THREAD_INHERIT_CONTEXT}\n"

#ifdef Py_GIL_DISABLED

"#s{-X} #L{tlbc}#b{=[0|1]}: enable (#B{1}) or disable (#B{0}) thread-local bytecode. Also\n"

"         #e{PYTHON_TLBC}\n"

#endif

"#s{-X} #L{tracemalloc}#b{[=N]}: trace Python memory allocations; N sets a traceback limit\n"

"         of #B{N} frames (default: #B{1}); also #e{PYTHONTRACEMALLOC}#B{=N}\n"

"#s{-X} #L{utf8}#b{[=0|1]}: enable (#B{1}) or disable (#B{0}) UTF-8 mode; also #e{PYTHONUTF8}\n"

"#s{-X} #L{warn_default_encoding}: enable opt-in EncodingWarning for 'encoding=None';\n"

"         also #e{PYTHONWARNDEFAULTENCODING}\n"

;

/* Envvars that don't have equivalent command-line options are listed first */

static const char usage_envvars[] =

"#h{Environment variables that change behavior:}\n"

"#E{PYTHONASYNCIODEBUG}: enable asyncio debug mode\n"

"#E{PYTHON_BASIC_REPL}: use the traditional parser-based REPL\n"

"#E{PYTHONBREAKPOINT}: if this variable is set to #B{0}, it disables the default\n"

"                  debugger.  It can be set to the callable of your debugger of\n"

"                  choice.\n"

"#E{PYTHONCASEOK}    : ignore case in 'import' statements (Windows)\n"

"#E{PYTHONCOERCECLOCALE}: if this variable is set to #B{0}, it disables the locale\n"

"                  coercion behavior.  Use #e{PYTHONCOERCECLOCALE}#B{=warn} to request\n"

"                  display of locale coercion and locale compatibility warnings\n"

"                  on stderr.\n"

"#E{PYTHON_COLORS}   : if this variable is set to #B{1}, the interpreter will colorize\n"

"                  various kinds of output.  Setting it to #B{0} deactivates\n"

"                  this behavior.\n"

#ifdef Py_TRACE_REFS

"#E{PYTHONDUMPREFS}  : dump objects and reference counts still alive after shutdown\n"

"#E{PYTHONDUMPREFSFILE}: dump objects and reference counts to the specified file\n"

#endif

#ifdef __APPLE__

"#E{PYTHONEXECUTABLE}: set sys.argv[0] to this value (macOS only)\n"

#endif

"#E{PYTHONHASHSEED}  : if this variable is set to 'random', a random value is used\n"

"                  to seed the hashes of str and bytes objects.  It can also be\n"

"                  set to an integer in the range [0,4294967295] to get hash\n"

"                  values with a predictable seed.\n"

"#E{PYTHON_HISTORY}  : the location of a .python_history file.\n"

"#E{PYTHONHOME}      : alternate <prefix> directory (or <prefix>#D<exec_prefix>).\n"

"                  The default module search path uses #H.\n"

"#E{PYTHONIOENCODING}: encoding[:errors] used for stdin/stdout/stderr\n"

#ifdef MS_WINDOWS

"#E{PYTHONLEGACYWINDOWSFSENCODING}: use legacy \"mbcs\" encoding for file system\n"

"#E{PYTHONLEGACYWINDOWSSTDIO}: use legacy Windows stdio\n"

#endif

"#E{PYTHONMALLOC}    : set the Python memory allocators and/or install debug hooks\n"

"                  on Python memory allocators.  Use #e{PYTHONMALLOC}#B{=debug} to\n"

"                  install debug hooks.\n"

"#E{PYTHONMALLOCSTATS}: print memory allocator statistics\n"

"#E{PYTHONPATH}      : '#D'-separated list of directories prefixed to the\n"

"                  default module search path.  The result is sys.path.\n"

"#E{PYTHONPLATLIBDIR}: override sys.platlibdir\n"

"#E{PYTHONSTARTUP}   : file executed on interactive startup (no default)\n"

"#E{PYTHONUSERBASE}  : defines the user base directory (site.USER_BASE)\n"

"\n"

"#h{These variables have equivalent command-line options (see }#e{--help} for details):\n"

"#E{PYTHON_CONTEXT_AWARE_WARNINGS}: if true (#B{1}), enable thread-safe warnings\n"

"                  module behaviour (#S{-X} #e{context_aware_warnings})\n"

"#E{PYTHON_CPU_COUNT}: override the return value of os.cpu_count() (#S{-X} #e{cpu_count})\n"

"#E{PYTHONDEBUG}     : enable parser debug mode (#S{-d})\n"

"#E{PYTHONDEVMODE}   : enable Python Development Mode (#S{-X} #e{dev})\n"

"#E{PYTHONDONTWRITEBYTECODE}: don't write .pyc files (#S{-B})\n"

"#E{PYTHONFAULTHANDLER}: dump the Python traceback on fatal errors (#S{-X} #e{faulthandler})\n"

"#E{PYTHON_FROZEN_MODULES}: whether to use frozen modules; the default is \"#B{on}\"\n"

"                  for installed Python and \"#B{off}\" for a local build\n"

"                  (#S{-X} #e{frozen_modules})\n"

#ifdef Py_GIL_DISABLED

"#E{PYTHON_GIL}      : when set to #B{0}, disables the GIL (#S{-X} #e{gil})\n"

#endif

"#E{PYTHONINSPECT}   : inspect interactively after running script (#S{-i})\n"

"#E{PYTHONINTMAXSTRDIGITS}: limit the size of int<->str conversions;\n"

"                  0 disables the limit (#S{-X} #e{int_max_str_digits}#B{=N})\n"

"#E{PYTHON_LAZY_IMPORTS}: control global lazy imports (#S{-X} #e{lazy_imports})\n"

"#E{PYTHONNODEBUGRANGES}: don't include extra location information in code objects\n"

"                  (#S{-X} #e{no_debug_ranges})\n"

"#E{PYTHONNOUSERSITE}: disable user site directory (#S{-s})\n"

"#E{PYTHONOPTIMIZE}  : enable level 1 optimizations (#S{-O})\n"

"#E{PYTHON_PERF_JIT_SUPPORT}: enable Linux \"perf\" profiler support with JIT\n"

"                  (#S{-X} #e{perf_jit})\n"

"#E{PYTHONPERFSUPPORT}: support the Linux \"perf\" profiler (#S{-X} #e{perf})\n"

#ifdef Py_DEBUG

"#E{PYTHON_PRESITE}: import this module before site (#S{-X} #e{presite})\n"

#endif

"#E{PYTHONPROFILEIMPORTTIME}: show how long each import takes (#S{-X} #e{importtime})\n"

"#E{PYTHONPYCACHEPREFIX}: root directory for bytecode cache (pyc) files\n"

"                  (#S{-X} #e{pycache_prefix})\n"

"#E{PYTHONSAFEPATH}  : don't prepend a potentially unsafe path to sys.path.\n"

#ifdef Py_STATS

"#E{PYTHONSTATS}     : turns on statistics gathering (#S{-X} #e{pystats})\n"

#endif

"#E{PYTHON_THREAD_INHERIT_CONTEXT}: if true (#B{1}), threads inherit context vars\n"

"                  (#S{-X} #e{thread_inherit_context})\n"

#ifdef Py_GIL_DISABLED

"#E{PYTHON_TLBC}     : when set to #B{0}, disables thread-local bytecode (#S{-X} #e{tlbc})\n"

#endif

"#E{PYTHONTRACEMALLOC}: trace Python memory allocations (#S{-X} #e{tracemalloc})\n"

"#E{PYTHONUNBUFFERED}: disable stdout/stderr buffering (#S{-u})\n"

"#E{PYTHONUTF8}      : control the UTF-8 mode (#S{-X} #e{utf8})\n"

"#E{PYTHONVERBOSE}   : trace import statements (#S{-v})\n"

"#E{PYTHONWARNDEFAULTENCODING}: enable opt-in EncodingWarning for 'encoding=None'\n"

"                  (#S{-X} #e{warn_default_encoding})\n"

"#E{PYTHONWARNINGS}  : warning control (#S{-W})\n"

;

/* --- Global configuration variables ----------------------------- */

// Variable removed from Python limited C API 3.16, but kept in the stable ABI

PyAPI_DATA(int) Py_UTF8Mode;

/* UTF-8 mode (PEP 540): if equal to 1, use the UTF-8 encoding, and change

   stdin and stdout error handler to "surrogateescape". */

int Py_UTF8Mode = 0;

static PyObject *

_Py_GetGlobalVariablesAsDict(void)

{

    extern const char *Py_FileSystemDefaultEncoding;

    extern const char *Py_FileSystemDefaultEncodeErrors;

    extern int Py_HasFileSystemDefaultEncoding;

    extern int _Py_HasFileSystemDefaultEncodeErrors;

    PyObject *dict = PyDict_New();

    if (dict == NULL) {

        return NULL;

    }

#define SET_ITEM(KEY, EXPR) \

        do { \

            PyObject *obj = (EXPR); \

            if (obj == NULL) { \

                goto fail; \

            } \

            int res = PyDict_SetItemString(dict, (KEY), obj); \

            Py_DECREF(obj); \

            if (res < 0) { \

                goto fail; \

            } \

        } while (0)

#define SET_ITEM_INT(VAR) \

    SET_ITEM(#VAR, PyLong_FromLong(VAR))

#define FROM_STRING(STR) \

    ((STR != NULL) ? \

        PyUnicode_FromString(STR) \

        : Py_NewRef(Py_None))

#define SET_ITEM_STR(VAR) \

    SET_ITEM(#VAR, FROM_STRING(VAR))

    SET_ITEM_STR(Py_FileSystemDefaultEncoding);

    SET_ITEM_INT(Py_HasFileSystemDefaultEncoding);

    SET_ITEM_STR(Py_FileSystemDefaultEncodeErrors);

    SET_ITEM_INT(_Py_HasFileSystemDefaultEncodeErrors);

    SET_ITEM_INT(Py_UTF8Mode);

    return dict;

fail:

    Py_DECREF(dict);

    return NULL;

#undef FROM_STRING

#undef SET_ITEM

#undef SET_ITEM_INT

#undef SET_ITEM_STR

}

char*

Py_GETENV(const char *name)

{

    int use_environment = 1;

    PyThreadState *tstate = PyThreadState_GetUnchecked();

    if (tstate != NULL) {

        const PyConfig *config = &tstate->interp->config;

        use_environment = config->use_environment;

    }

    if (!use_environment) {

        return NULL;

    }

    return getenv(name);

}

/* --- PyStatus ----------------------------------------------- */

PyStatus PyStatus_Ok(void)

{ return _PyStatus_OK(); }

PyStatus PyStatus_Error(const char *err_msg)

{

    assert(err_msg != NULL);

    return (PyStatus){._type = _PyStatus_TYPE_ERROR,

                      .err_msg = err_msg};

}

PyStatus PyStatus_NoMemory(void)

{ return PyStatus_Error("memory allocation failed"); }

PyStatus PyStatus_Exit(int exitcode)

{ return _PyStatus_EXIT(exitcode); }

int PyStatus_IsError(PyStatus status)

{ return _PyStatus_IS_ERROR(status); }

int PyStatus_IsExit(PyStatus status)

{ return _PyStatus_IS_EXIT(status); }

int PyStatus_Exception(PyStatus status)

{ return _PyStatus_EXCEPTION(status); }

void

_PyErr_SetFromPyStatus(PyStatus status)

{

    if (!_PyStatus_IS_ERROR(status)) {

        PyErr_Format(PyExc_SystemError,

                     "_PyErr_SetFromPyStatus() status is not an error");

        return;

    }

    const char *err_msg = status.err_msg;

    if (err_msg == NULL || strlen(err_msg) == 0) {

        PyErr_Format(PyExc_SystemError,

                     "_PyErr_SetFromPyStatus() status has no error message");

        return;

    }

    if (strcmp(err_msg, _PyStatus_NO_MEMORY_ERRMSG) == 0) {

        PyErr_NoMemory();

        return;

    }

    const char *func = status.func;

    if (func) {

        PyErr_Format(PyExc_RuntimeError, "%s: %s", func, err_msg);

    }

    else {

        PyErr_Format(PyExc_RuntimeError, "%s", err_msg);

    }

}

/* --- PyWideStringList ------------------------------------------------ */

#ifndef NDEBUG

int

_PyWideStringList_CheckConsistency(const PyWideStringList *list)

{

    assert(list->length >= 0);

    if (list->length != 0) {

        assert(list->items != NULL);

    }

    for (Py_ssize_t i = 0; i < list->length; i++) {

        assert(list->items[i] != NULL);

    }

    return 1;

}

#endif   /* Py_DEBUG */

static void

_PyWideStringList_ClearEx(PyWideStringList *list,

                          bool use_default_allocator)

{

    assert(_PyWideStringList_CheckConsistency(list));

    for (Py_ssize_t i=0; i < list->length; i++) {

        if (use_default_allocator) {

            _PyMem_DefaultRawFree(list->items[i]);

        }

        else {

            PyMem_RawFree(list->items[i]);

        }

    }

    if (use_default_allocator) {

        _PyMem_DefaultRawFree(list->items);

    }

    else {

        PyMem_RawFree(list->items);

    }

    list->length = 0;

    list->items = NULL;

}

void

_PyWideStringList_Clear(PyWideStringList *list)

{

    _PyWideStringList_ClearEx(list, false);

}

static int

_PyWideStringList_CopyEx(PyWideStringList *list,

                         const PyWideStringList *list2,

                         bool use_default_allocator)

{

    assert(_PyWideStringList_CheckConsistency(list));

    assert(_PyWideStringList_CheckConsistency(list2));

    if (list2->length == 0) {

        _PyWideStringList_ClearEx(list, use_default_allocator);

        return 0;

    }

    PyWideStringList copy = _PyWideStringList_INIT;

    size_t size = list2->length * sizeof(list2->items[0]);

    if (use_default_allocator) {

        copy.items = _PyMem_DefaultRawMalloc(size);

    }

    else {

        copy.items = PyMem_RawMalloc(size);

    }

    if (copy.items == NULL) {

        return -1;

    }

    for (Py_ssize_t i=0; i < list2->length; i++) {

        wchar_t *item;

        if (use_default_allocator) {

            item = _PyMem_DefaultRawWcsdup(list2->items[i]);

        }

        else {

            item = _PyMem_RawWcsdup(list2->items[i]);

        }

        if (item == NULL) {

            _PyWideStringList_ClearEx(&copy, use_default_allocator);

            return -1;

        }

        copy.items[i] = item;

        copy.length = i + 1;

    }

    _PyWideStringList_ClearEx(list, use_default_allocator);

    *list = copy;

    return 0;

}

int

_PyWideStringList_Copy(PyWideStringList *list, const PyWideStringList *list2)

{

    return _PyWideStringList_CopyEx(list, list2, false);

}

PyStatus

PyWideStringList_Insert(PyWideStringList *list,

                        Py_ssize_t index, const wchar_t *item)

{

    Py_ssize_t len = list->length;

    if (len == PY_SSIZE_T_MAX) {

        /* length+1 would overflow */

        return _PyStatus_NO_MEMORY();

    }

    if (index < 0) {

        return _PyStatus_ERR("PyWideStringList_Insert index must be >= 0");

    }

    if (index > len) {

        index = len;

    }

    wchar_t *item2 = _PyMem_RawWcsdup(item);

    if (item2 == NULL) {

        return _PyStatus_NO_MEMORY();

    }

    size_t size = (len + 1) * sizeof(list->items[0]);

    wchar_t **items2 = (wchar_t **)PyMem_RawRealloc(list->items, size);

    if (items2 == NULL) {

        PyMem_RawFree(item2);

        return _PyStatus_NO_MEMORY();

    }

    if (index < len) {

        memmove(&items2[index + 1],

                &items2[index],

                (len - index) * sizeof(items2[0]));

    }

    items2[index] = item2;

    list->items = items2;

    list->length++;

    return _PyStatus_OK();

}

PyStatus

PyWideStringList_Append(PyWideStringList *list, const wchar_t *item)

{

    return PyWideStringList_Insert(list, list->length, item);

}

PyStatus

_PyWideStringList_Extend(PyWideStringList *list, const PyWideStringList *list2)

{

    for (Py_ssize_t i = 0; i < list2->length; i++) {

        PyStatus status = PyWideStringList_Append(list, list2->items[i]);

        if (_PyStatus_EXCEPTION(status)) {

            return status;

        }

    }

    return _PyStatus_OK();

}

static int

_PyWideStringList_Find(PyWideStringList *list, const wchar_t *item)

{

    for (Py_ssize_t i = 0; i < list->length; i++) {

        if (wcscmp(list->items[i], item) == 0) {

            return 1;

        }

    }

    return 0;

}

PyObject*

_PyWideStringList_AsList(const PyWideStringList *list)

{

    assert(_PyWideStringList_CheckConsistency(list));

    PyObject *pylist = PyList_New(list->length);

    if (pylist == NULL) {

        return NULL;

    }

    for (Py_ssize_t i = 0; i < list->length; i++) {

        PyObject *item = PyUnicode_FromWideChar(list->items[i], -1);

        if (item == NULL) {

            Py_DECREF(pylist);

            return NULL;

        }

        PyList_SET_ITEM(pylist, i, item);

    }

    return pylist;

}

static PyObject*

_PyWideStringList_AsTuple(const PyWideStringList *list)

{

    assert(_PyWideStringList_CheckConsistency(list));

    PyObject *tuple = PyTuple_New(list->length);

    if (tuple == NULL) {

        return NULL;

    }

    for (Py_ssize_t i = 0; i < list->length; i++) {

        PyObject *item = PyUnicode_FromWideChar(list->items[i], -1);

        if (item == NULL) {

            Py_DECREF(tuple);

            return NULL;

        }

        PyTuple_SET_ITEM(tuple, i, item);

    }

    return tuple;

}

/* --- Py_GetArgcArgv() ------------------------------------------- */

void

_Py_ClearArgcArgv(void)

{

    _PyWideStringList_ClearEx(&_PyRuntime.orig_argv, true);

}

static int

_Py_SetArgcArgv(Py_ssize_t argc, wchar_t * const *argv)

{

    const PyWideStringList argv_list = {.length = argc, .items = (wchar_t **)argv};

    // XXX _PyRuntime.orig_argv only gets cleared by Py_Main(),

    // so it currently leaks for embedders.

    return _PyWideStringList_CopyEx(&_PyRuntime.orig_argv, &argv_list, true);

}

// _PyConfig_Write() calls _Py_SetArgcArgv() with PyConfig.orig_argv.

void

Py_GetArgcArgv(int *argc, wchar_t ***argv)

{

    *argc = (int)_PyRuntime.orig_argv.length;

    *argv = _PyRuntime.orig_argv.items;

}

/* --- PyConfig ---------------------------------------------- */

#define MAX_HASH_SEED 4294967295UL

#ifndef NDEBUG

static int

config_check_consistency(const PyConfig *config)

{

    /* Check config consistency */

    assert(config->isolated >= 0);

    assert(config->use_environment >= 0);

    assert(config->dev_mode >= 0);

    assert(config->install_signal_handlers >= 0);

    assert(config->use_hash_seed >= 0);

    assert(config->hash_seed <= MAX_HASH_SEED);

    assert(config->faulthandler >= 0);

    assert(config->tracemalloc >= 0);

    assert(config->import_time >= 0);

    assert(config->code_debug_ranges >= 0);

    assert(config->show_ref_count >= 0);

    assert(config->dump_refs >= 0);

    assert(config->malloc_stats >= 0);

    assert(config->pymalloc_hugepages >= 0);

    assert(config->site_import >= 0);

    assert(config->bytes_warning >= 0);

    assert(config->warn_default_encoding >= 0);

    assert(config->inspect >= 0);

    assert(config->interactive >= 0);

    assert(config->optimization_level >= 0);

    assert(config->parser_debug >= 0);

    assert(config->write_bytecode >= 0);

    assert(config->verbose >= 0);

    assert(config->quiet >= 0);

    assert(config->user_site_directory >= 0);

    assert(config->parse_argv >= 0);

    assert(config->configure_c_stdio >= 0);

    assert(config->buffered_stdio >= 0);

    assert(_PyWideStringList_CheckConsistency(&config->orig_argv));

    assert(_PyWideStringList_CheckConsistency(&config->argv));

    /* sys.argv must be non-empty: empty argv is replaced with [''] */

    assert(config->argv.length >= 1);

    assert(_PyWideStringList_CheckConsistency(&config->xoptions));

    assert(_PyWideStringList_CheckConsistency(&config->warnoptions));

    assert(_PyWideStringList_CheckConsistency(&config->module_search_paths));

    assert(config->module_search_paths_set >= 0);

    assert(config->filesystem_encoding != NULL);

    assert(config->filesystem_errors != NULL);

#ifdef MS_WINDOWS

    /* stdio_encoding can be NULL in the legacy Windows stdio mode. */

    assert(config->stdio_encoding != NULL || config->legacy_windows_stdio);

    assert(config->legacy_windows_stdio >= 0);

#else

    assert(config->stdio_encoding != NULL);