Repository navigation
fix hang on dfhack exit on windows - #6004
Merged
Merged
Conversation
This fixed a lifelong bug in the implementation of DFHack's console on WIndows: calling `FreeConsole` while another thread is waiting in `ReadConsoleInput` on the same console has undefined behavior in Windows, and recent releases of WIndows _changed the behavior_ in a manner that is detrimental to our use. This change adds a Windows event object that the console now waits for in parallel with the console read handle. Shutdown signals the event object, causing the console thread to exit cleanly when the core wants the console to shut down. The console never waits in `ReadConsoleInput` as this is only called when console input is known to be available. The same problem would theoretically exist for Linux, but the Linux implementation has always had a pipe (used as an expensive standin for a event object as Linux doesn't have event objects that can be waited for in parallel with file handles) to yield the same result. Fixes DFHack#6003
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
2 participants
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.
This fixed a lifelong bug in the implementation of DFHack's console on WIndows: calling
FreeConsolewhile another thread is waiting inReadConsoleInputon the same console has undefined behavior in Windows, and recent releases of WIndows changed the behavior in a manner that is detrimental to our use.This change adds a Windows event object that the console now waits for in parallel with the console read handle. Shutdown signals the event object, causing the console thread to exit cleanly when the core wants the console to shut down. The console never waits in
ReadConsoleInputas this is only called when console input is known to be available.The same problem would theoretically exist for Linux, but the Linux implementation has always had a pipe (used as an expensive standin for a event object as Linux doesn't have event objects that can be waited for in parallel with file handles) to yield the same result.
Fixes #6003