bpo-42015: Reorder dereferencing calls in meth_dealloc, to make sure m_self is kept alive long enough #22670
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…m_self is kept alive long enough
|
And since this PR fixes a bug exposed in user code, add please a NEWS entry. |
serhiy-storchaka
added
needs backport to 3.9
…l, and add NEWS blurb
Not sure whether that mostly belongs in "C API" or "Core and Builtins", but I went with "C API" because I expected users are mostly affected when using the C API. If necessary, I can still move it. |
Misc/NEWS.d/next/C API/2020-10-12-20-13-58.bpo-42015.X4H2_V.rst
Outdated
Show resolved
Hide resolved
|
Thanks for the amazingly quick review, @serhiy-storchaka! Amazing to submit a PR like this :-) |
|
Thanks @YannickJadoul for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Oct 12, 2020
…m_self is kept alive long enough (pythonGH-22670) (cherry picked from commit 04b8631) Co-authored-by: Yannick Jadoul <[email protected]>
|
GH-22674 is a backport of this pull request to the 3.9 branch. |
|
I will be glad to work with you! |
miss-islington
added a commit
that referenced
this pull request
Oct 12, 2020
…m_self is kept alive long enough (GH-22670) (cherry picked from commit 04b8631) Co-authored-by: Yannick Jadoul <[email protected]>
5 tasks
xzy3
pushed a commit
to xzy3/cpython
that referenced
this pull request
Oct 18, 2020
…m_self is kept alive long enough (pythonGH-22670)
This was referenced Dec 3, 2020
|
|
adorilson
pushed a commit
to adorilson/cpython
that referenced
this pull request
Mar 13, 2021
…m_self is kept alive long enough (pythonGH-22670)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In Python 3.9, the line
Py_XDECREF(PyCFunction_GET_CLASS(m));was added tometh_dealloc(inmethodobject.c). Unfortunately for pybind11, it's inserted exactly two lines too low, since it accesses thePyMethodDefand we store thePyMethodDefinstance in the capsule that's used asself-argument of thePyCFunction.Result: UB, since
Py_XDECREF(m->m_self);brings down the refcount of the capsule to 0 and (indirectly) frees thePyMethodDef, while its contents are now still accessed.From the pybind11 perspective, it would be optimal if this could be fixed in CPython itself, by moving up this one
Py_XDECREF2 lines. This would a) be more efficient than creating a workaround, and b) allow old, existing versions of pybind11 to work with Python 3.9 (well, 3.9.1, then, hopefully); the user base of pybind11 has grown quite a bit and now includes giants like scipy or some Google libraries.This PR reorders those lines.
If there's a different, recommended way of creating these
PyCFunctionObjects dynamically and cleaning up thePyMethodDef, we'd be interested as well, to make sure these kinds of breakages are avoided in the future.Apologies for only figuring out now how to debug this, using valgrind. Up until yesterday, we only saw some failures in CI on macOS, but it was hard to reproduce and debug locally.
https://bugs.python.org/issue42015