Fix leak in nrnpy_store_savestate_.
#3229
Merged
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
Facts:
* `PyObject_CallObject` returns a new reference [1].
* `PyByteArray_Size` doesn't steal the reference [2].
* `PyByteArray_AsString` doesn't steal the reference [3].
This is a leak because:
* `PyObject_CallObject` returns a new reference: `+1`.
* `Py_INCREF` increases the local reference count to `+2`.
* `PyByteArray_Size` and `PyByteArray_AsString` don't steal the
reference.
* `Py_DECREF` reduces the local reference count to `+1`.
Therefore, there's 1 INCREF we can't pair up with a DECREF.
The revised version does:
* Takes ownership of the new reference with `nb::steal`. Therefore,
the local reference count is `+0`.
* `PyByteArray_Size` and `PyByteArray_AsString` don't steal the
reference.
Therefore, all INCREF can be paired with a DECREF.
[1]: https://docs.python.org/3/c-api/call.html#c.PyObject_CallObject
[2]: https://docs.python.org/3/c-api/bytearray.html#c.PyByteArray_Size
[3]: https://docs.python.org/3/c-api/bytearray.html#c.PyByteArray_AsString
|
alkino
approved these changes
Nov 20, 2024
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #3229 +/- ##
==========================================
- Coverage 67.08% 67.07% -0.01%
==========================================
Files 569 569
Lines 111190 111161 -29
==========================================
- Hits 74590 74564 -26
+ Misses 36600 36597 -3 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
|
✔️ 9ba4a9d -> Azure artifacts URL |
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.
Facts:
PyObject_CallObjectreturns a new reference 1.PyByteArray_Sizedoesn't steal the reference 2.PyByteArray_AsStringdoesn't steal the reference 3.This is a leak because:
PyObject_CallObjectreturns a new reference:+1.Py_INCREFincreases the local reference count to+2.PyByteArray_SizeandPyByteArray_AsStringdon't steal the reference.Py_DECREFreduces the local reference count to+1.Therefore, there's 1 INCREF we can't pair up with a DECREF.
The revised version does:
nb::steal. Therefore, the local reference count is+0.PyByteArray_SizeandPyByteArray_AsStringdon't steal the reference.Therefore, all INCREF can be paired with a DECREF.