Apply double check pattern to avoid race condition in LoggingService #11284
Conversation
This file contains 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
YuliiaKovalova
force-pushed
the
dev/ykovalova/better_handle_event_reset
branch
from
95adccd to
3611f9a
Compare
YuliiaKovalova
force-pushed
the
dev/ykovalova/better_handle_event_reset
branch
from
50d0c8c to
74a1a74
Compare
There was a problem hiding this comment.
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
JanKrivanek
reviewed
Jan 30, 2025
| _emptyQueueEvent.Set(); | ||
| _emptyQueueEvent?.Set(); | ||
| } | ||
| catch (Exception) |
There was a problem hiding this comment.
Let's try to avoid this - we'd have no indications of unexpected behavior from labs or watsons
| // Long-lived event handles that never get disposed to avoid race conditions. | ||
| private readonly AutoResetEvent _longLivedDequeueEvent = new AutoResetEvent(false); | ||
| private readonly ManualResetEvent _longLivedEmptyQueueEvent = new ManualResetEvent(true); | ||
| private readonly AutoResetEvent _longLivedEnqueueEvent = new AutoResetEvent(false); |
| { | ||
| _emptyQueueEvent.Set(); | ||
| // Check if instance fields are nulled (cleanup was called) | ||
| if (_eventQueue == null || _dequeueEvent == null || _emptyQueueEvent == null || _enqueueEvent == null) |
There was a problem hiding this comment.
These can still get nullified right after checking.
We should store them in local variables and check and use those here. Then nullyfying in the close method could be kept
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: https://dev.azure.com/devdiv/DevDiv/_workitems/edit/2320135/
Context
Reset()method invocation sometimes causes exceptionSystem.IO.IOException: 'The handle is invalid.'.Very likely it happens on application shutdown.
The assumption is:
Changes Made
To resolve this issue, the double-check pattern was implemented for the event fields.
This double-check approach prevents the 'invalid handle' exception from occurring during the race condition between component shutdown and the execution of the logging thread.
Testing
N/A