Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-44050: Extension modules can share state when they don't support sub-interpreters. #27794

Merged
merged 5 commits into from
Oct 5, 2021

Conversation

shihai1991
Copy link
Member

@shihai1991 shihai1991 commented Aug 17, 2021

https://bugs.python.org/issue44050

Automerge-Triggered-By: GH:encukou

@shihai1991 shihai1991 changed the title Extension modules created from PyModule_Create() can share state. bpo-44050: Extension modules created from PyModule_Create() can share state. Aug 17, 2021
@encukou
Copy link
Member

encukou commented Aug 17, 2021

I don't understand this PR. It allows Python objects to be shared between interpreters, doesn't it?

@shihai1991
Copy link
Member Author

I don't understand this PR. It allows Python objects to be shared between interpreters, doesn't it?

Hi, petr. The details in this PR: 82c83bd
Only the main interp can update the extension and def.m_base.m_copy now. So I use the def->m_slots to identify the extension module created from PyModule_Create() or not. If extension module created from the PyModule_Create(), keep the old behavior. cc @vstinner

@encukou
Copy link
Member

encukou commented Aug 17, 2021

The relevant check is done by the def->m_size == -1. Extensions that use multi-phase init must set a non-negative m_size.

@shihai1991
Copy link
Member Author

shihai1991 commented Aug 17, 2021

The relevant check is done by the def->m_size == -1. Extensions that use multi-phase init must set a non-negative m_size.

Hm. I agree with you. But the user of bpo-44050 got the error in v3.9.6. And I found some module created from PyModule_Create() use m_size. For example: https://github.com/python/cpython/blob/v3.9.6/Modules/_posixsubprocess.c#L986

@shihai1991
Copy link
Member Author

This PR can be removed when all the extension modules convert to multi-phase init.

@encukou
Copy link
Member

encukou commented Aug 17, 2021

Why is it important to ask whether the module was created by PyModule_Create?

@encukou
Copy link
Member

encukou commented Aug 17, 2021

This PR can be removed when all the extension modules convert to multi-phase init.

That includes third-party modules, so: this PR can be removed when the API for single-phase init is removed.

@shihai1991
Copy link
Member Author

Why is it important to ask whether the module was created by PyModule_Create?

Make sure only the single extension module shared between interpreters. The extension module from multi-phase init can be created seperately in subinterpreter, right?

@encukou
Copy link
Member

encukou commented Aug 17, 2021

All modules with non-negative m_size shouldn't be shared across interpreters, regardless of how they're created.

@shihai1991
Copy link
Member Author

All modules with non-negative m_size shouldn't be shared across interpreters, regardless of how they're created.

Make sense. Looks your idea would be better. Thanks:) I will update it soon.

@vstinner
Copy link
Member

_PyImport_FixupExtensionObject() copies the namespace from the first instance of an extension, to newly created instances of the extension. It's better than using exactly the same module object with the same dict dictionary object. In a perfect world, all extensions would use multi-phase init and so don't go through _PyImport_FixupExtensionObject().

Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but can you try to write an unit test?

Would it be possible to write an unit test for this? https://bugs.python.org/issue44050 is a regression. It would be better to not reintroduce it by mistake tomorrow.

Maybe using the ssl module: if if it's already imported, skip the test. Otherwise, spawn a subinterpreter to import it, and then import it in the main interpreter, and compare if you get the same objects or not.

See wee-slack/wee-slack#812 (comment) for a more complete example.

To make sure that the ssl module is not imported yet, you can run the test in a subprocess, eg. using assert_python_ok(), or subprocess.

@shihai1991
Copy link
Member Author

LGTM, but can you try to write an unit test?

Would it be possible to write an unit test for this? https://bugs.python.org/issue44050 is a regression. It would be better to not reintroduce it by mistake tomorrow.

Maybe using the ssl module: if if it's already imported, skip the test. Otherwise, spawn a subinterpreter to import it, and then import it in the main interpreter, and compare if you get the same objects or not.

See wee-slack/wee-slack#812 (comment) for a more complete example.

To make sure that the ssl module is not imported yet, you can run the test in a subprocess, eg. using assert_python_ok(), or subprocess.

OK, victor. I will update it.

@shihai1991 shihai1991 changed the title bpo-44050: Extension modules created from PyModule_Create() can share state. bpo-44050: Extension modules doesn't support sub-interpreters can share state. Aug 17, 2021
@encukou
Copy link
Member

encukou commented Aug 18, 2021

Maybe using the ssl module

That won't do; ssl uses multi-phase init (as should all other stdlib modules, one day). This would need to be a new module dedicated for the test.
You can look at Modules/_testmultiphase.c and Lib/test/test_capi.py for an example of adding a new module without adding a new shared library.

@shihai1991 shihai1991 closed this Aug 21, 2021
@encukou
Copy link
Member

encukou commented Sep 7, 2021

Looks good, although it looks like it'll only be backported to 3.10.1.
Could you add a NEWS entry, though? We should have those for bugfixes.

@encukou encukou removed the skip news label Sep 7, 2021
@trygveaa
Copy link

trygveaa commented Sep 7, 2021

Looks good, although it looks like it'll only be backported to 3.10.1.

What do you mean? The regression is in 3.9, the issue is fixed in 3.10, and 3.10.1 doesn't exist yet. Did you mean 3.9.1?

@shihai1991
Copy link
Member Author

Looks good, although it looks like it'll only be backported to 3.10.1.

What do you mean? The regression is in 3.9, the issue is fixed in 3.10, and 3.10.1 doesn't exist yet. Did you mean 3.9.1?

Maybe we cloud backport to 3.9 and 3.10?

@encukou
Copy link
Member

encukou commented Oct 5, 2021

What do you mean? The regression is in 3.9, the issue is fixed in 3.10, and 3.10.1 doesn't exist yet. Did you mean 3.9.1?

The "fix" in 3.10 is in the _ssl module only – an unrelated change that made the module avoid this bug.

Backporting to 3.10.1 & the next 3.9 sounds fine.

@encukou encukou added needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Oct 5, 2021
@encukou encukou changed the title bpo-44050: Extension modules can share state when it doesn't support sub-interpreters. bpo-44050: Extension modules can share state when they don't support sub-interpreters. Oct 5, 2021
@miss-islington
Copy link
Contributor

@shihai1991: Status check is done, and it's a success ✅ .

@miss-islington miss-islington merged commit b9bb748 into python:main Oct 5, 2021
@miss-islington
Copy link
Contributor

Thanks @shihai1991 for the PR 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry, @shihai1991, I could not cleanly backport this to 3.9 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker b9bb74871b27d9226df2dd3fce9d42bda8b43c2b 3.9

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 5, 2021
…sub-interpreters. (pythonGH-27794)

Automerge-Triggered-By: GH:encukou
(cherry picked from commit b9bb748)

Co-authored-by: Hai Shi <shihai1992@gmail.com>
@miss-islington miss-islington self-assigned this Oct 5, 2021
@bedevere-bot
Copy link

GH-28738 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 5, 2021
@shihai1991
Copy link
Member Author

Thanks Petr, Victor for your review and merge.

ambv pushed a commit to ambv/cpython that referenced this pull request Oct 5, 2021
…pport sub-interpreters. (pythonGH-27794)

Automerge-Triggered-By: GH:encukou.
(cherry picked from commit b9bb748)

Co-authored-by: Hai Shi <shihai1992@gmail.com>
@bedevere-bot
Copy link

GH-28741 is a backport of this pull request to the 3.9 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Oct 5, 2021
ambv pushed a commit that referenced this pull request Oct 5, 2021
…sub-interpreters. (GH-27794) (GH-28738)

Automerge-Triggered-By: GH:encukou
(cherry picked from commit b9bb748)

Co-authored-by: Hai Shi <shihai1992@gmail.com>
ambv added a commit that referenced this pull request Oct 5, 2021
…pport sub-interpreters. (GH-27794) (GH-28741)

(cherry picked from commit b9bb748)

Co-authored-by: Hai Shi <shihai1992@gmail.com>
@encukou
Copy link
Member

encukou commented Oct 12, 2021

And thanks for your patience; this certainly waited for longer than it should have.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants