Add TSMutex lock guard#13188
Open
bneradt wants to merge 1 commit into
Open
Conversation
Plugin code that protects small critical sections with TSMutex has to pair every early return with a matching unlock. That pattern is easy to get wrong and makes the intended lock lifetime harder to see. This adds a small TSMutexLockGuard helper to the plugin API and uses it in plugin code where the mutex naturally stays locked until a return path.
bneradt
added
TS API
Plugins
Enhancement
easy_review
zwoop
approved these changes
May 21, 2026
| class TSMutexLockGuard | ||
| { | ||
| public: | ||
| explicit TSMutexLockGuard(TSMutex mutexp) : m_mutex(mutexp) { TSMutexLock(m_mutex); } |
Contributor
There was a problem hiding this comment.
[[nodiscard("Did you forget to name your lock guard variable?")]]
explicit TSMutexLockGuard(TSMutex mutexp) : m_mutex(mutexp) { TSMutexLock(m_mutex); }
or some such ? This prevents a user from accidentally making a no-op lock guard (which almost certainly is not what they want). Albeit nitpicky, it feels useful in a public (plugin) API.
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.
Plugin code that protects small critical sections with TSMutex has to pair
every early return with a matching unlock. That pattern is easy to get wrong
and makes the intended lock lifetime harder to see.
This adds a small TSMutexLockGuard helper to the plugin API and uses it in
plugin code where the mutex naturally stays locked until a return path.