Skip to content

fix: wrapping context __exit__ leak [backport 2.21] #13635

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

Open
wants to merge 1 commit into
base: 2.21
Choose a base branch
from

Conversation

github-actions[bot]
Copy link
Contributor

Backport e7c0d74 from #13626 to 2.21.

We fix a leak in the universal wrapping context caused to bound exit method leaking in CPython 3.9 and 3.10. This was due to a reference to the bound method exit of the universal wrapping context not getting popped from the stack before every return statement. Every call to a wrapped function would then create one such bounded method object that would not get GC'd. No other versions of CPython are affected because the bytecode and/or approach are different.

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

We fix a leak in the universal wrapping context caused to bound __exit__
method leaking in CPython 3.9 and 3.10. This was due to a reference to
the bound method __exit__ of the universal wrapping context not getting
popped from the stack before every return statement. Every call to a
wrapped function would then create one such bounded method object that
would not get GC'd. No other versions of CPython are affected because
the bytecode and/or approach are different.

## Checklist
- [ ] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

(cherry picked from commit e7c0d74)
@github-actions github-actions bot added the Dynamic Instrumentation Dynamic Instrumentation/Live Debugger label Jun 10, 2025
@github-actions github-actions bot requested review from a team as code owners June 10, 2025 12:55
@github-actions github-actions bot added the Dynamic Instrumentation Dynamic Instrumentation/Live Debugger label Jun 10, 2025
@brettlangdon brettlangdon reopened this Jun 10, 2025
@brettlangdon brettlangdon enabled auto-merge (squash) June 10, 2025 12:56
Copy link
Contributor Author

CODEOWNERS have been resolved as:

releasenotes/notes/fix-wrapping-context-memory-leak-ad3d8f27586ba662.yaml  @DataDog/apm-python
ddtrace/internal/wrapping/context.py                                    @DataDog/apm-core-python
tests/internal/test_wrapping.py                                         @DataDog/debugger-python @DataDog/apm-core-python

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

Successfully merging this pull request may close these issues.

4 participants