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

fix(profiler): update memalloc guard #11460

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

Conversation

sanchda
Copy link
Contributor

@sanchda sanchda commented Nov 20, 2024

Previously, the memory allocation profiler would use Python's builtin thread-local storage interfaces in order to set and get the state of a thread-local guard.

I've updated a few things here.

  • I think get/set idioms are slightly problematic for this type of code, since it pushes the responsibility of maintaining clean internal state up to the parent. A consequence of this is that the propagation of the underlying state by value opens the door for race conditions if execution changes between contexts (unlikely here, but I think minimizing indirection is still cleaner). Accordingly, I've updated this to use native thread-local storage
  • Based on @nsrip-dd's observation, I widened the guard over free() operations. I believe this is correct, and if it isn't then the detriment is performance, not correctness.
  • I got rid of the PY37 failovers

We don't have any reproductions for the defects that prompted this change, but I've been running a patched library in an environment that does reproduce the behavior, and I haven't seen any defects.

  1. I don't believe this patch is harmful, and if our memory allocation tests pass then I believe it should be fine.
  2. I have a reason to believe this fixes a critical defect, which can cause crashes.

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

Copy link
Contributor

github-actions bot commented Nov 20, 2024

CODEOWNERS have been resolved as:

ddtrace/profiling/collector/_memalloc_reentrant.c                       @DataDog/profiling-python
ddtrace/profiling/collector/_memalloc.c                                 @DataDog/profiling-python
ddtrace/profiling/collector/_memalloc_heap.c                            @DataDog/profiling-python
ddtrace/profiling/collector/_memalloc_reentrant.h                       @DataDog/profiling-python
ddtrace/profiling/collector/_memalloc_tb.c                              @DataDog/profiling-python
ddtrace/profiling/collector/_pymacro.h                                  @DataDog/profiling-python
setup.py                                                                @DataDog/python-guild

@pr-commenter
Copy link

pr-commenter bot commented Nov 20, 2024

Benchmarks

Benchmark execution time: 2024-11-22 06:39:05

Comparing candidate commit 06db082 in PR branch sanchda/memalloc_lock with baseline commit a664aab in branch main.

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

@sanchda sanchda requested a review from a team as a code owner November 20, 2024 18:14
@sanchda sanchda changed the title Better memalloc guard? fix(profiler): update memalloc guard Nov 20, 2024
@datadog-dd-trace-py-rkomorn
Copy link

datadog-dd-trace-py-rkomorn bot commented Nov 21, 2024

Datadog Report

Branch report: sanchda/memalloc_lock
Commit report: 5659e3a
Test service: dd-trace-py

✅ 0 Failed, 1236 Passed, 232 Skipped, 7m 3.56s Total duration (18m 34.62s time saved)

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

Successfully merging this pull request may close these issues.

4 participants