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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Remove logging that could occur while a thread is suspended #2014

Merged
merged 3 commits into from Jul 28, 2022

Conversation

indragiek
Copy link
Member

@indragiek indragiek commented Jul 28, 2022

馃摐 Description

Remove some logging that could happen when threads fail to be suspended or resumed.

馃挕 Motivation and Context

SENTRY_PROF_LOG_KERN_RETURN will result in a call to a logger that may perform a heap allocation, which is dangerous for the reasons documented here:

// ############################################

This is an unlikely scenario - if the thread_suspend call fails and we log an error, the thread is likely not suspended - but the logs are low value enough that it's better not to take the risk.

馃挌 How did you test it?

This is preventing a hard-to-reproduce scenario so there's no way to easily unit test it, but we check that all existing tests pass.

馃摑 Checklist

  • I reviewed the submitted code
  • I added tests to verify the changes
  • I updated the docs if needed
  • Review from the native team if needed
  • No breaking changes

馃敭 Next steps

return SENTRY_PROF_LOG_KERN_RETURN(thread_suspend(handle_)) == KERN_SUCCESS;
return thread_suspend(handle_) == KERN_SUCCESS;
Copy link
Member

Choose a reason for hiding this comment

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

We could eventually store the errno and log it after resuming the thread as well.

@indragiek indragiek merged commit 3b70b5b into master Jul 28, 2022
@indragiek indragiek deleted the indragiek/remove-dangerous-logs branch July 28, 2022 15:29
kevinrenskers added a commit that referenced this pull request Aug 1, 2022
* master:
  ci: benchmarking and profile generation improvements (#2022)
  release: 7.23.0
  fix: Bad merge on CHANGELOG.md (#2020)
  fix: Log empty samples instead of collecting stacks for idle threads (#2013)
  fix: Handle failure to read thread priority gracefully (#2015)
  fix: Remove logging that could occur while a thread is suspended (#2014)
  fix: Use constant for max thread name size instead of magic number (#2012)
  Disable flaky tesDefaultMaxEnvelopesConcurrent (#2018)
  Fix build failure in unit tests (#2019)
  Fix address sanitizer compilation error (#1996)
  fix: Sauce labs iPhone 13 pro iOS version
  feat: Add transaction to baggage and trace headers (#1992)
  ci: fix ui thread starvation in benchmarks (#2009)
  fix: Add more descriptive deprecation message for enableProfiling (#2011)
  feat: Add sampling configuration for profiling (#2004)
  fix log message option name (#2006)
  meta: add armcknight as a codeowner (#2008)
  release: 7.22.0
  fix: Disable broken LaunchUITests to unblock release (#2003)

# Conflicts:
#	Samples/iOS-Swift/iOS-Swift/ViewControllers/PerformanceViewController.swift
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants