Skip to content

fix: wrapping context __exit__ leak #13626

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

Merged
merged 2 commits into from
Jun 10, 2025
Merged

Conversation

P403n1x87
Copy link
Contributor

@P403n1x87 P403n1x87 commented Jun 9, 2025

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

@P403n1x87 P403n1x87 requested review from a team as code owners June 9, 2025 13:29
@P403n1x87 P403n1x87 added the Dynamic Instrumentation Dynamic Instrumentation/Live Debugger label Jun 9, 2025
Copy link
Contributor

github-actions bot commented Jun 9, 2025

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

@brettlangdon brettlangdon enabled auto-merge (squash) June 9, 2025 13:33
Copy link
Contributor

github-actions bot commented Jun 9, 2025

Bootstrap import analysis

Comparison of import times between this PR and base.

Summary

The average import time from this PR is: 273 ± 3 ms.

The average import time from base is: 275 ± 4 ms.

The import time difference between this PR and base is: -2.1 ± 0.2 ms.

Import time breakdown

The following import paths have shrunk:

ddtrace.auto 2.006 ms (0.74%)
ddtrace.bootstrap.sitecustomize 1.327 ms (0.49%)
ddtrace.bootstrap.preload 1.327 ms (0.49%)
ddtrace.internal.remoteconfig.client 0.652 ms (0.24%)
ddtrace 0.680 ms (0.25%)
ddtrace.internal._unpatched 0.023 ms (0.01%)

@pr-commenter
Copy link

pr-commenter bot commented Jun 9, 2025

Benchmarks

Benchmark execution time: 2025-06-09 14:20:47

Comparing candidate commit d99949c in PR branch fix/wrapping-context-memory-leak with baseline commit 10e09e0 in branch main.

Found 0 performance improvements and 2 performance regressions! Performance is the same for 549 metrics, 3 unstable metrics.

scenario:iastaspects-upper_aspect

  • 🟥 execution_time [+179.813ns; +234.954ns] or [+7.922%; +10.351%]

scenario:iastaspectsospath-ospathnormcase_aspect

  • 🟥 execution_time [+420.536ns; +467.938ns] or [+12.213%; +13.589%]

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.
@P403n1x87 P403n1x87 force-pushed the fix/wrapping-context-memory-leak branch from d99949c to 060ea5c Compare June 9, 2025 14:29
@P403n1x87 P403n1x87 requested a review from tylfin June 9, 2025 15:02
Copy link
Contributor

@tylfin tylfin left a comment

Choose a reason for hiding this comment

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

LGTM

@brettlangdon brettlangdon merged commit e7c0d74 into main Jun 10, 2025
869 of 871 checks passed
@brettlangdon brettlangdon deleted the fix/wrapping-context-memory-leak branch June 10, 2025 12:55
github-actions bot pushed a commit that referenced this pull request Jun 10, 2025
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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.21 Dynamic Instrumentation Dynamic Instrumentation/Live Debugger
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants