bug: Use RecursiveMutex and read locking on getEventSubscriber #5841
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.
I noticed
osquery_events_tests_inotifytests-test
is a flaky test because ofgetEventSubscriber
:This is an unprotected race condition and one (of few) callsite is within
EventPublisher::fire
. This test exercises the race because it may remove the specific event subscriber before all inotify events have been serviced. Thus theexists
works and theat
throws.There are two options IMO to address the issue:
getEventSubscriberUnsafe
that does not lock and keep one that waterfalls, which does.The first option requires a RecursiveMutex since additional callsites are requesting a WriteLock then needing a ReadLock. This seems like the simplest approach.
There is no performance impact measured at the millisecond granularity incurred by introducing the lock and moving to a RecursiveMutex. Note that this code change highlights a few places where the code could be improved, specifically not searching a map twice. I do not want to perform these optimizations within the same PR.