fix(mutex): auto-detect thread safety attributes and annotate lock/unlock (fixes #2263) - #2298
Open
jdymitarai wants to merge 1 commit into
Open
fix(mutex): auto-detect thread safety attributes and annotate lock/unlock (fixes #2263)#2298jdymitarai wants to merge 1 commit into
jdymitarai wants to merge 1 commit into
Conversation
This file contains hidden or 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
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.
Fixes #2263
Problem
When compiling with Clang with
-Wthread-safetyenabled (such as on macOS or under Bazel defaults),src/mutex.hproduces-Wthread-safety-analysiserrors:This occurs because:
HAVE_THREAD_SAFETY_ATTRIBUTESwas not defined by default in CMake or Bazel, so thread safety annotations expand to no-ops unless manually supplied via compiler flags.std::mutexhas thread safety annotations (such as libc++ on macOS), callingmut_.lock()andmut_.unlock()within the wrapper methods withoutNO_THREAD_SAFETY_ANALYSISflagsmut_as an unreleased lock at function exit.Solution
__has_attribute(capability) && __has_attribute(scoped_lockable) && __has_attribute(guarded_by).-DHAVE_THREAD_SAFETY_ATTRIBUTES=0.NO_THREAD_SAFETY_ANALYSIStoMutex::lock()andMutex::unlock()to suppress internal capability analysis onmut_while preservingACQUIRE()/RELEASE()contracts for callers.Verification
ctest: 100% passed (0 failed).