_ast module: get_global_ast_state() doesn't work with Mercurial lazy import

[vstinner]

BPO	41631
Nosy	@vstinner, @DinoV, @encukou, @ambv, @ericsnowcurrently, @manueljacob, @corona10, @pablogsal, @isidentical, @shihai1991
PRs	bpo-41631: _ast module uses again a global state #21961 bpo-41631: Check that importing _ast returns the right module  #21973 [3.9] bpo-41631: _ast module uses again a global state (GH-21961) #22258 [3.9] bpo-41631: Fix a compiler warning in pycore_pylifecycle.h #22331 bpo-41796: Make _ast module state per interpreter #23024

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2020-09-15.21:32:12.176>
created_at = <Date 2020-08-25.10:16:01.780>
labels = ['library', '3.9', '3.10']
title = "_ast module: get_global_ast_state() doesn't work with Mercurial lazy import"
updated_at = <Date 2020-10-29.11:52:17.187>
user = 'https://github.com/vstinner'

bugs.python.org fields:

activity = <Date 2020-10-29.11:52:17.187>
actor = 'vstinner'
assignee = 'none'
closed = True
closed_date = <Date 2020-09-15.21:32:12.176>
closer = 'vstinner'
components = ['Library (Lib)']
creation = <Date 2020-08-25.10:16:01.780>
creator = 'vstinner'
dependencies = []
files = []
hgrepos = []
issue_num = 41631
keywords = ['patch']
message_count = 23.0
messages = ['375881', '375883', '375884', '375948', '375950', '375951', '375952', '375955', '375956', '375957', '376256', '376564', '376565', '376573', '376574', '376575', '376686', '376708', '376874', '376946', '376950', '376955', '376956']
nosy_count = 10.0
nosy_names = ['vstinner', 'dino.viehland', 'petr.viktorin', 'lukasz.langa', 'eric.snow', 'mjacob', 'corona10', 'pablogsal', 'BTaskaya', 'shihai1991']
pr_nums = ['21961', '21973', '22258', '22331', '23024']
priority = None
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue41631'
versions = ['Python 3.9', 'Python 3.10']

[vstinner]

Building Mercurial with Python 3.9.0rc1 fails with the error:

SystemError: <built-in function compile> returned NULL without setting an error

The problem comes from the PyAST_Check() function. This function calls get_global_ast_state() which gets the state of the _ast module. If the module is not imported yet, it is imported.

The problem is that Mercurial monkey-patches the __import__() builtin function to implement lazy imports. get_global_ast_state() calls PyImport_Import() which returns a Mercurial _LazyModule(name='_ast', ...) object. Calling get_ast_state() (PyModule_GetState()) on it is unsafe since it's not the _ast extension module, but another module (which has no state, PyModule_GetState() returns NULL).

https://bugzilla.redhat.com/show_bug.cgi?id=1871992#c1

--

The _ast extension module was modified multiple times recently:

• September 2019: The extension was converted to PEP-384 (stable ABI): bpo-38113, commit ac46eb4
• July 2020: The extension was converted to PEP-489 (multiphase init): bpo-41194, commit b1cc6ba
• (and bugfixes: see bpo-41194 and bpo-41204)

I did the PEP-489 change to fix a regression caused by the first change (PEP-384), two bugs in fact:

• bpo-41194 Python 3.9.0b3 crash on compile() in PyAST_Check() when the _ast module is loaded more than once
• bpo-41261: 3.9-dev SEGV in object_recursive_isinstance in ast.literal_eval

[vstinner]

One option is to revert all AST changes of bpo-38113 (and following changes), to move back to the state before bpo-38113, until all issues are addressed.

[pablogsal]

Given how close are we to a release for 3.9 we should try to maximize stability.

[encukou]

Regarding ac46eb4:
Module states come and go with the modules that contain them; if a "get_global_ast_state" or "astmodulestate_global" needs to be accessed from outside the module, it shouldn't be module state :/

----

So, the main issue here is that the AST types are not used only by the _ast module, but by the interpreter itself: the compile() builtin and Py_CompileStringObject.

I see two ways of fixing this properly:

1. All the classes _ast provides should be built-in, like, say, function. (Currently, that means they should be static types; later they could be per-interpreter.)
   The _ast module should merely expose them from Python, like the types module exposes the function type.
   This would mean that calling Py_CompileStringObject with PyCF_ONLY_AST will be independent of the _ast module.

2. The mod2obj/obj2mod functions, called by e.g. compile(..., PyCF_ONLY_AST), should:

• import the _ast module
• call a Python-accessible function, e.g. _ast._mod2obj
  This would mean replacing the _ast module (in sys.modules or through an import hook, which you can do from Python code) will affect what AST types will be used throughout the interpreter.

[pablogsal]

The mod2obj/obj2mod functions, called by e.g. compile(..., PyCF_ONLY_AST), should:

• import the _ast module
• call a Python-accessible function, e.g. _ast._mod2obj

Would that impact performance considerably?

[pablogsal]

Also, option 1 is virtually equivalent to the state of the _ast module prior to the recent changes except that the symbols are in a shared object instead of the binary or libpython. The advantage here is not moving them out of the shared object, is making them having static storage.

[pablogsal]

Also, adding them into a module that needs access through Python had a bootstrap problem:

Basically:

initializing import system -> initialize codec -> compile -> ast init -> init ast module -> 💥

[encukou]

Also, option 1 is virtually equivalent to the state of the _ast module prior to the recent changes except that the symbols are in a shared object instead of the binary or libpython. The advantage here is not moving them out of the shared object, is making them having static storage.

What I'm not yet clear on: when is that shared object is initialized and destroyed?

Would that impact performance considerably?
Also, adding them into a module that needs access through Python had a bootstrap problem

Only for PyCF_ONLY_AST, which is, AFAIK, not used by the interpreter itself.

[pablogsal]

What I'm not yet clear on: when is that shared object is initialized and destroyed?

I am assuming that you mean at the Python level and not at the linker level. Then:

• Initialized: when dlopen on import.

• Destroyed: never. The interpreter does not dlclose the shared objects.

[pablogsal]

Initialized: when dlopen on import.

With this I mean import-> dlopen -> dlsym for init function -> call init function

[vstinner]

At commit ac46eb4 ("bpo-38113: Update the Python-ast.c generator to PEP-384 (gh-15957)"):
---------------

static struct PyModuleDef _astmodule = {
    PyModuleDef_HEAD_INIT,
    "_ast",
    NULL,
    sizeof(astmodulestate),
    NULL,
    NULL,
    astmodule_traverse,
    astmodule_clear,
    astmodule_free,
};

#define astmodulestate_global ((astmodulestate *)PyModule_GetState(PyState_FindModule(&_astmodule)))

PyMODINIT_FUNC
PyInit__ast(void)
{
    PyObject *m;
    if (!init_types()) return NULL;
    m = PyState_FindModule(&_astmodule);
    ...
    return m;
}

---

=> I investigated bpo-41194 crash again. It seems like the root issue is more than PyInit__ast() returns a *borrowed* reference, rather than a strong reference.

=> The _ast module can only be loaded once, astmodule_free() and astmodule_clear() are not called at Python exit.

At commit 91e1bc1 ("bpo-41194: The _ast module cannot be loaded more than once (GH-21290)"):
---------------
static astmodulestate global_ast_state;

static astmodulestate *
get_ast_state(PyObject *Py_UNUSED(module))
{
return &global_ast_state;
}

#define get_global_ast_state() (&global_ast_state)

static struct PyModuleDef _astmodule = {
    PyModuleDef_HEAD_INIT,
    .m_name = "_ast",
    .m_size = -1,
    .m_traverse = astmodule_traverse,
    .m_clear = astmodule_clear,
    .m_free = astmodule_free,
};

PyMODINIT_FUNC
PyInit__ast(void)
{
    PyObject *m = PyModule_Create(&_astmodule);
    if (!m) {
        return NULL;
    }
    astmodulestate *state = get_ast_state(m);
    ...
}

---

• bpo-41194 => ok, PyInit__ast() is fine
• bpo-41631 => ok: PyAST_Check() doesn't import the module, it uses a global state.
• bpo-41261 => ERROR: This implementation allows to create two instances of the _ast module, but also to unload one instance (call astmodule_free), because _astmodule.m_size = -1.

At commit b1cc6ba ("bpo-41194: Convert _ast extension to PEP-489 (GH-21293)"):
---------------

static astmodulestate*
get_global_ast_state(void)
{
    ...
    PyObject *module = PyImport_GetModule(name);
    if (module == NULL) {
        if (PyErr_Occurred()) {
            return NULL;
        }
        module = PyImport_Import(name);
        if (module == NULL) {
            return NULL;
        }
    }
    ...
    astmodulestate *state = get_ast_state(module);
    Py_DECREF(module);
    return state;
}

static struct PyModuleDef _astmodule = {
    PyModuleDef_HEAD_INIT,
    .m_name = "_ast",
    .m_size = sizeof(astmodulestate),
    .m_slots = astmodule_slots,
    .m_traverse = astmodule_traverse,
    .m_clear = astmodule_clear,
    .m_free = astmodule_free,
};

PyMODINIT_FUNC
PyInit__ast(void)
{
return PyModuleDef_Init(&_astmodule);
}
---------------

• bpo-41631 => ERROR: PyAST_Check() imports "_ast" module

[encukou]

I also looked into Mercurial. They have a large list of modules [0] that don't work with the lazy-loading scheme. I don't think adding one more should be a big problem for them; but we'll reach out to them and confirm that.

[0] https://www.mercurial-scm.org/repo/hg/file/tip/hgdemandimport/__init__.py#l26

[encukou]

We need this bug solved for 3.9.0 rc2. Łukasz, you're the one to make the call about the approach; how can we make your job easier?

My view is:

• Victor's PR 21961 is going in the right direction. But, as far as I know (correct me if I'm wrong), Victor unfortunately has less time for CPython than usual, for personal reasons. So, the PR is unexpectedly stalled. I don't think there's enough time to fix and test it for RC 2.

• My PR 21973 essentially just provides a better error message (and might prevent segfaults in more convoluted cases -- essentially ones where the _ast module is replaced maliciously). We can merge it, backport to 3.9; then iterate on Victor's PR to have a better solution in 3.10.

But Pablo an Victor should chime in as well.

[manueljacob]

I couldn’t reproduce the problem with a freshly compiled Python 3.9.0rc1 on Arch Linux. Was this ever reproduced on a non-Red Hat system?

[encukou]

That is interesting.

The original post here doesn't mention that the problem occurs in Mercurial's "make all", specifically when building documentation, in the command:

/usr/bin/python3.9 gendoc.py "hgrc.5" > hgrc.5.txt.tmp

Could you confirm make all works OK with python3.9 on Arch?

[manueljacob]

I was running "make all" and I also ran the documentation generator command without an error.

However, I tried it again and now it failed the same way as reported. With a debug build, I get "Python/Python-ast.c:231: get_ast_state: Assertion `state != NULL' failed.".

Sorry for the noise!

[vstinner]

About subinterpreters. In Python 3.8, _ast.AST type is a static type:

static PyTypeObject AST_type = {...};

In Python 3.9, it's now a heap type:

static PyType_Spec AST_type_spec = {...};
state->AST_type = PyType_FromSpec(&AST_type_spec);

In Python 3.8, the same _ast.AST type was shared by all interpreters. With my PR 21961, the _ast.AST type is a heap type but it is also shared by all interpreters.

Compared to Python 3.8, PR 21961 has no regression related to subinterpreters. It's not better nor worse. The minor benefit is that _ast.AST is cleared at Python exit (see _PyAST_Fini()).

While I would be nice to make _ast.AST per interpreter, it would be an *enhancement*. I consider that it can wait for Python 3.10.

[vstinner]

Compared to Python 3.8, PR 21961 has no regression related to subinterpreters.

Oh. I forgot that static types cannot be modified (in Python, but it's possible in C). So my PR still changed the behavior compared to 3.8:
---

import _testcapi
import _ast
res = _testcapi.run_in_subinterp("import _ast; _ast.AST.x = 1")
if res != 0:
    raise Exception("bug")
print(_ast.AST.x)

---

On Python 3.8, this code snippet fails with:

TypeError: can't set attributes of built-in/extension type '_ast.AST'

On master, it is possible to modify or add an _ast.AST attribute. Since PR 21961 moves back to a global strange, Petr is correct that a subinterpreter can now modify the state of another subinterpreter the _ast.AST type.

So I modified my PR 21961 to revert partially the change which converted AST_type type from a static type to a heap type.

My PR 21961 converts AST_type back to a static type, to avoid these problems. Sadly, it makes _ast module incompatible with PEP-384, but the priority is to fix this 3rd regression. We can reconsider converting PEP-384 back to a heap type later, but we will have to be careful with not reintroducing all these bugs.

[vstinner]

I marked bpo-41766 as a duplicate of this issue.

[ambv]

New changeset e5fbe0c by Victor Stinner in branch 'master':
bpo-41631: _ast module uses again a global state (bpo-21961)
e5fbe0c

[ambv]

New changeset 55e0836 by Pablo Galindo in branch '3.9':
[3.9] bpo-41631: _ast module uses again a global state (GH-21961) (GH-22258)
55e0836

[vstinner]

I close the issue. I tested manually: the fix works as expected.

I reproduced https://bugzilla.redhat.com/show_bug.cgi?id=1871992#c1 bug (I had to comment the workaround of the mercurial package in Fedora) on 3.9:

make[1]: Entering directory '/home/vstinner/mercurial/mercurial-5.4/doc'
/home/vstinner/python/3.9/python gendoc.py "hgrc.5" > hgrc.5.txt.tmp
python: Python/Python-ast.c:231: get_ast_state: Assertion `state != NULL' failed.

I confirm that the fix in 3.9 works as expected:

New changeset 55e0836 by Pablo Galindo in branch '3.9'

=> No crash with this fix.

I also reproduced the bug in the master branch (without the fix), and I also confirm that the fix in master does fix the crash.

[vstinner]

I also tested bpo-41261 reproducer and https://bugs.python.org/issue41194#msg372863 reproducer on 3.9 and master branches: Python doesn't crash.